BlockingConsumerFactory - Code Metrics - projectmentor/laravel-quota - Measure and Improve Code Quality continuously with Scrutinizer

BlockingConsumerFactory A
last analyzed 2017-04-26 01:29 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	13
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

Metric	Value
wmc	1
lcom	0
cbo	1
dl	0
loc	13
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	make()	0	4	1

<?php

/**
 * This file is part of laravel-quota
 *
 * (c) David Faith <[email protected]>
 *
 * Full copyright and license information is available
 * in the LICENSE file distributed with this source code.
 */

namespace Projectmentor\Quota\Factories;

use bandwidthThrottle\tokenBucket\BlockingConsumer;
use Projectmentor\Quota\Contracts\FactoryInterface;
use Projectmentor\Quota\Contracts\PayloadInterface;

/**
 * This is the blockingConsumer factory class.
 *
 * @author David Faith <[email protected]>
 */
class BlockingConsumerFactory implements FactoryInterface
{
    /**
     * Make a new BlockingConsumer instance.
     *
     * @param \Projectmentor\Quota\Stubs\PayloadInterface $data

     * @return \Projectmentor\Quota\BlockingConsumer

     */
    public function make(PayloadInterface $data)
    {
        return new BlockingConsumer($data->getBucket());
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.
    }
}
    }
}



1		<?php
2
3		/**
4		* This file is part of laravel-quota
5		*
6		* (c) David Faith <[email protected]>
7		*
8		* Full copyright and license information is available
9		* in the LICENSE file distributed with this source code.
10		*/
11
12		namespace Projectmentor\Quota\Factories;
13
14		use bandwidthThrottle\tokenBucket\BlockingConsumer;
15		use Projectmentor\Quota\Contracts\FactoryInterface;
16		use Projectmentor\Quota\Contracts\PayloadInterface;
17
18		/**
19		* This is the blockingConsumer factory class.
20		*
21		* @author David Faith <[email protected]>
22		*/
23		class BlockingConsumerFactory implements FactoryInterface
24		{
25		/**
26		* Make a new BlockingConsumer instance.
27		*
28		* @param \Projectmentor\Quota\Stubs\PayloadInterface $data
		0 ignored issues – show Documentation introduced 2017-04-24 03:28 UTC by Report Bug Copy Issue Report Should the type for parameter `$data` not be `PayloadInterface`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
29		* @return \Projectmentor\Quota\BlockingConsumer
		0 ignored issues – show Documentation introduced 2017-04-24 03:28 UTC by Report Bug Copy Issue Report Should the return type not be `BlockingConsumer`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
30		*/
31	1	public function make(PayloadInterface $data)
32		{
33	1	return new BlockingConsumer($data->getBucket());
		0 ignored issues – show Bug introduced 2017-04-24 02:24 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Projectmentor\Quota\Contracts\PayloadInterface` as the method `getBucket()` does only exist in the following implementations of said interface: `Projectmentor\Quota\Stubs\BlockingConsumerData`. 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... Bug Best Practice introduced 2017-04-24 02:24 UTC by Report Bug Copy Issue Report The return type of `return new \bandwidthThr...er($data->getBucket());` (`bandwidthThrottle\tokenBucket\BlockingConsumer`) is incompatible with the return type declared by the interface `Projectmentor\Quota\Cont...\FactoryInterface::make` of type `Projectmentor\Quota\Contracts\QuotaInterface`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { / ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
34		}
35		}
		0 ignored issues – show Coding Style introduced 2017-04-24 03:28 UTC by Report Bug Copy Issue Report As per coding style, files should not end with a newline character. This check marks files that end in a newline character, i.e. an empy line. Loading history...
36

projectmentor / laravel-quota

BlockingConsumerFactory A last analyzed 2017-04-26 01:29 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

1 Method

Available Fixes

Duplication Side-by-Side

Filter issues like

BlockingConsumerFactory A
last analyzed 2017-04-26 01:29 UTC