QueueCommands - Code Metrics - Inspection of "worklog events, schedule events, new socketInjecto..." - comodojo/extender.framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 2.0 ( 29c56f...2f2bc4 )

by Marco

created 2017-12-20 00:30 UTC

QueueCommands A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	36
Duplicated Lines	27.78 %

Coupling/Cohesion

Components	0
Dependencies	2

Importance

Changes

Metric	Value
wmc	4
lcom	0
cbo	2
dl	10
loc	36
rs	10
c	0
b	0
f	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	queueAdd()	0	5	1
A	queueAddBulk()	0	5	1
A	queueInfo()	10	10	1
A	getManager()	0	9	1

How to fix Duplicated Code

<?php namespace Comodojo\Extender\Socket;

use \Comodojo\Extender\Queue\Manager;
use \Comodojo\Daemon\Process;
use \Comodojo\Extender\Task\Request;

/**
* @package     Comodojo Extender
* @author      Marco Giovinazzi <[email protected]>
* @license     MIT
*
* LICENSE:
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
 */

class QueueCommands {

    public function queueAdd(Process $daemon, Request $request = null) {

        return self::getManager($daemon)->add($request);
function notNullable(stdClass $x) { }

// Unsafe
function withoutCheck(stdClass $x = null) {
    notNullable($x);
}

// Safe - Alternative 1: Adding Additional Type-Check
function withCheck(stdClass $x = null) {
    if ($x instanceof stdClass) {
        notNullable($x);
    }
}

// Safe - Alternative 2: Changing Parameter
function withNonNullableParam(stdClass $x) {
    notNullable($x);
}

    }

    public function queueAddBulk(Process $daemon, array $requests = []) {

        return self::getManager($daemon)->addBulk($requests);

    }

    public function queueInfo(Process $daemon, $data = null) {


        $configuration = $daemon->getConfiguration();
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
        $base_path = $configuration->get('base-path');
        $lock_path = $configuration->get('run-path');
        $lock_file = "$base_path/$lock_path/queue.worker.lock";

        return unserialize(file_get_contents($lock_file));

    }

    protected static function getManager(Process $daemon) {

        return new Manager(
            $daemon->getConfiguration(),
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
            $daemon->getLogger(),
            $daemon->getEvents()
        );

    }

}


1		<?php namespace Comodojo\Extender\Socket;
2
3		use \Comodojo\Extender\Queue\Manager;
4		use \Comodojo\Daemon\Process;
5		use \Comodojo\Extender\Task\Request;
6
7		/**
8		* @package Comodojo Extender
9		* @author Marco Giovinazzi <[email protected]>
10		* @license MIT
11		*
12		* LICENSE:
13		*
14		* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15		* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16		* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17		* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18		* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19		* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20		* THE SOFTWARE.
21		*/
22
23		class QueueCommands {
24
25		public function queueAdd(Process $daemon, Request $request = null) {
26
27		return self::getManager($daemon)->add($request);
		0 ignored issues – show Bug introduced 2017-09-26 22:48 UTC by Report Bug Copy Issue Report It seems like `$request` defined by parameter `$request` on line `25` can be `null`; however, `Comodojo\Extender\Queue\Manager::add()` does not accept `null`, maybe add an additional type check? It seems like you allow that null is being passed for a parameter, however the function which is called does not seem to accept null. We recommend to add an additional type check (or disallow null for the parameter): function notNullable(stdClass $x) { } // Unsafe function withoutCheck(stdClass $x = null) { notNullable($x); } // Safe - Alternative 1: Adding Additional Type-Check function withCheck(stdClass $x = null) { if ($x instanceof stdClass) { notNullable($x); } } // Safe - Alternative 2: Changing Parameter function withNonNullableParam(stdClass $x) { notNullable($x); } Loading history...
28
29		}
30
31		public function queueAddBulk(Process $daemon, array $requests = []) {
32
33		return self::getManager($daemon)->addBulk($requests);
34
35		}
36
37	View Code Duplication	public function queueInfo(Process $daemon, $data = null) {
		0 ignored issues – show Unused Code introduced 2017-09-26 22:48 UTC by Report Bug Copy Issue Report The parameter `$data` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Duplication introduced 2017-09-26 22:48 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...
38
39		$configuration = $daemon->getConfiguration();
		0 ignored issues – show Bug introduced 2017-09-26 22:48 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Comodojo\Daemon\Process` as the method `getConfiguration()` does only exist in the following sub-classes of `Comodojo\Daemon\Process`: `Comodojo\Extender\ExtenderDaemon`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
40		$base_path = $configuration->get('base-path');
41		$lock_path = $configuration->get('run-path');
42		$lock_file = "$base_path/$lock_path/queue.worker.lock";
43
44		return unserialize(file_get_contents($lock_file));
45
46		}
47
48		protected static function getManager(Process $daemon) {
49
50		return new Manager(
51		$daemon->getConfiguration(),
		0 ignored issues – show Bug introduced 2017-09-26 22:48 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Comodojo\Daemon\Process` as the method `getConfiguration()` does only exist in the following sub-classes of `Comodojo\Daemon\Process`: `Comodojo\Extender\ExtenderDaemon`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
52		$daemon->getLogger(),
53		$daemon->getEvents()
54		);
55
56		}
57
58		}
59

comodojo / extender.framework

Push — 2.0 ( 29c56f...2f2bc4 )

QueueCommands A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

4 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like