ClassDiscovery::getPuliFactory() - Code Metrics - Inspection of "Use Puli discovery" - php-http/discovery - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#34)

by Márk

created 2015-12-25 20:51 UTC

ClassDiscovery::getPuliFactory() A

↳ Parent: ClassDiscovery

Complexity

Conditions	4
Paths	4

Size

Total Lines	18
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	4

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	18
ccs	6
cts	6
cp	1
rs	9.2
cc	4
eloc	9
nc	4
nop	0
crap	4

<?php

namespace Http\Discovery;

use Puli\Discovery\Api\Discovery;

/**
 * Registry that based find results on class existence.
 *
 * @author David de Boer <[email protected]>
 * @author Márk Sági-Kazár <[email protected]>
 */
abstract class ClassDiscovery
{
    /**
     * @var GeneratedPuliFactory
     */
    private static $puliFactory;

    /**
     * @var Discovery
     */
    private static $puliDiscovery;

    /**
     * @return GeneratedPuliFactory
     */
    public static function getPuliFactory()
    {
        if (null === self::$puliFactory) {
            if (!defined('PULI_FACTORY_CLASS')) {
                throw new \RuntimeException('Puli Factory is not available');
            }

            $puliFactoryClass = PULI_FACTORY_CLASS;

            if (!class_exists($puliFactoryClass)) {
                throw new \RuntimeException('Puli Factory class does not exist');
            }

            self::$puliFactory = new $puliFactoryClass();
        }

        return self::$puliFactory;
    }

    /**
     * Sets the Puli factory.
     *
     * @param object $puliFactory
     */
    public static function setPuliFactory($puliFactory)
    {
        if (!is_callable([$puliFactory, 'createRepository']) || !is_callable([$puliFactory, 'createDiscovery'])) {
            throw new \InvalidArgumentException('The Puli Factory must expose a repository and a discovery');
        }

        self::$puliFactory = $puliFactory;
        self::$puliDiscovery = null;
    }

    /**
     * Resets the factory.
     */
    public static function resetPuliFactory()
    {
        self::$puliFactory = null;
        self::$puliDiscovery = null;
    }

    /**
     * Returns the Puli discovery layer.
     *
     * @return Discovery
     */
    public static function getPuliDiscovery()
    {
        if (!isset(self::$puliDiscovery)) {
            $factory = self::getPuliFactory();
            $repository = $factory->createRepository();

            self::$puliDiscovery = $factory->createDiscovery($repository);
        }

        return self::$puliDiscovery;
    }

    /**
     * Finds a class.
     *
     * @param $type
     *
     * @return string
     *
     * @throws NotFoundException
     */
    public static function findOneByType($type)
    {
        $bindings = self::getPuliDiscovery()->findBindings($type);

        foreach ($bindings as $binding) {
            if ($binding->hasParameterValue('depends')) {
                $dependency = $binding->getParameterValue('depends');

                if (!self::evaluateCondition($dependency)) {
                    continue;
                }
            }

            // TODO: check class binding
            return $binding->getClassName();
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.
    }
}
        }

        throw new NotFoundException(sprintf('Binding of type "%s" not found', $type));
    }

    /**
     * Finds a resource.
     *
     * @return object
     */
    public static function find()
    {
        throw new \LogicException('Not implemented');
    }

    /**
     * Evaulates conditions to boolean.
     *
     * @param mixed $condition
     *
     * @return bool
     */
    protected static function evaluateCondition($condition)
    {
        if (is_string($condition)) {
            // Should be extended for functions, extensions???
            return class_exists($condition);
        } elseif (is_callable($condition)) {
            return $condition();
        } elseif (is_bool($condition)) {
            return $condition;
        } elseif (is_array($condition)) {
            $evaluatedCondition = true;

            // Immediately stop execution if the condition is false
            for ($i = 0; $i < count($condition) && false !== $evaluatedCondition; ++$i) {
                $evaluatedCondition &= static::evaluateCondition($condition[$i]);
            }

            return $evaluatedCondition;
        }

        return false;
    }
}


1		<?php
2
3		namespace Http\Discovery;
4
5		use Puli\Discovery\Api\Discovery;
6
7		/**
8		* Registry that based find results on class existence.
9		*
10		* @author David de Boer <[email protected]>
11		* @author Márk Sági-Kazár <[email protected]>
12		*/
13		abstract class ClassDiscovery
14		{
15		/**
16		* @var GeneratedPuliFactory
17		*/
18	7	private static $puliFactory;
19
20	7	/**
21		* @var Discovery
22		*/
23	7	private static $puliDiscovery;
24	7
25	7	/**
26		* @return GeneratedPuliFactory
27	7	*/
28	7	public static function getPuliFactory()
29		{
30		if (null === self::$puliFactory) {
31		if (!defined('PULI_FACTORY_CLASS')) {
32		throw new \RuntimeException('Puli Factory is not available');
33		}
34
35		$puliFactoryClass = PULI_FACTORY_CLASS;
36
37	14	if (!class_exists($puliFactoryClass)) {
38		throw new \RuntimeException('Puli Factory class does not exist');
39		}
40	14
41	1	self::$puliFactory = new $puliFactoryClass();
42		}
43
44	14	return self::$puliFactory;
45	13	}
46	13
47		/**
48	13	* Sets the Puli factory.
49		*
50	6	* @param object $puliFactory
51		*/
52	1	public static function setPuliFactory($puliFactory)
53		{
54		if (!is_callable([$puliFactory, 'createRepository']) \|\| !is_callable([$puliFactory, 'createDiscovery'])) {
55		throw new \InvalidArgumentException('The Puli Factory must expose a repository and a discovery');
56		}
57
58		self::$puliFactory = $puliFactory;
59		self::$puliDiscovery = null;
60		}
61
62	13	/**
63		* Resets the factory.
64	13	*/
65		public static function resetPuliFactory()
66	10	{
67	8	self::$puliFactory = null;
68	1	self::$puliDiscovery = null;
69	8	}
70	5
71	5	/**
72	4	* Returns the Puli discovery layer.
73		*
74		* @return Discovery
75	4	*/
76	4	public static function getPuliDiscovery()
77	4	{
78		if (!isset(self::$puliDiscovery)) {
79	4	$factory = self::getPuliFactory();
80		$repository = $factory->createRepository();
81
82	1	self::$puliDiscovery = $factory->createDiscovery($repository);
83		}
84
85		return self::$puliDiscovery;
86		}
87
88		/**
89		* Finds a class.
90		*
91		* @param $type
92		*
93		* @return string
94		*
95		* @throws NotFoundException
96		*/
97		public static function findOneByType($type)
98		{
99		$bindings = self::getPuliDiscovery()->findBindings($type);
100
101		foreach ($bindings as $binding) {
102		if ($binding->hasParameterValue('depends')) {
103		$dependency = $binding->getParameterValue('depends');
104
105		if (!self::evaluateCondition($dependency)) {
106		continue;
107		}
108		}
109
110		// TODO: check class binding
111		return $binding->getClassName();
		0 ignored issues – show Bug introduced 2015-12-25 20:45 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 `getClassName()` does only exist in the following implementations of said interface: `Puli\Discovery\Binding\ClassBinding`. 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...
112		}
113
114		throw new NotFoundException(sprintf('Binding of type "%s" not found', $type));
115		}
116
117		/**
118		* Finds a resource.
119		*
120		* @return object
121		*/
122		public static function find()
123		{
124		throw new \LogicException('Not implemented');
125		}
126
127		/**
128		* Evaulates conditions to boolean.
129		*
130		* @param mixed $condition
131		*
132		* @return bool
133		*/
134		protected static function evaluateCondition($condition)
135		{
136		if (is_string($condition)) {
137		// Should be extended for functions, extensions???
138		return class_exists($condition);
139		} elseif (is_callable($condition)) {
140		return $condition();
141		} elseif (is_bool($condition)) {
142		return $condition;
143		} elseif (is_array($condition)) {
144		$evaluatedCondition = true;
145
146		// Immediately stop execution if the condition is false
147		for ($i = 0; $i < count($condition) && false !== $evaluatedCondition; ++$i) {
148		$evaluatedCondition &= static::evaluateCondition($condition[$i]);
149		}
150
151		return $evaluatedCondition;
152		}
153
154		return false;
155		}
156		}
157

php-http / discovery

Pull Request — master (#34)

ClassDiscovery::getPuliFactory() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like