ApiKeyValTrait - Code Metrics - Inspection of "Refactored commands API" - dazzle-php/redis - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9e125a...9a1e57 )

by Kamil

created 2017-07-02 15:02 UTC

ApiKeyValTrait B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	606
Duplicated Lines	13.7 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

4.34%

Importance

Changes

Metric	Value
dl	83
loc	606
c	0
b	0
f	0
wmc	49
lcom	1
cbo	1
ccs	9
cts	207
cp	0.0434
rs	7.6705

46 Methods

Rating	Name	Duplication	Size	Complexity
	dispatch()	0	1	?
A	append()	0	7	1
A	bitCount()	0	7	1
B	bitField()	10	33	5
A	bitOp()	0	8	1
A	bitPos()	0	7	1
A	decr()	8	8	1
A	decrBy()	0	8	1
A	get()	7	7	1
A	getBit()	0	8	1
A	getRange()	0	8	1
A	getSet()	0	8	1
A	incr()	7	7	1
A	incrBy()	0	8	1
A	incrByFloat()	0	8	1
A	set()	0	8	1
A	setBit()	0	8	1
A	setEx()	0	7	1
A	setNx()	0	7	1
A	setRange()	0	7	1
A	pSetEx()	0	7	1
A	mGet()	0	9	1
A	mSet()	0	8	1
A	mSetNx()	0	8	1
A	strLen()	7	8	1
A	del()	8	8	1
A	dump()	8	8	1
A	exists()	0	9	1
A	expire()	0	8	1
A	expireAt()	0	8	1
A	persist()	7	7	1
A	pExpire()	0	8	1
A	pExpireAt()	0	8	1
A	touch()	0	8	1
A	ttl()	7	8	1
A	type()	7	7	1
A	unLink()	0	8	1
A	wait()	0	8	1
A	randomKey()	0	7	1
A	rename()	0	7	1
A	renameNx()	0	7	1
A	restore()	0	8	1
A	pTtl()	7	7	1
A	move()	0	8	1
A	scan()	0	8	1
A	sort()	0	9	1

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like ApiKeyValTrait often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use ApiKeyValTrait, and based on these observations, apply Extract Interface, too.

<?php

namespace Dazzle\Redis\Command\Compose;

use Dazzle\Redis\Command\Builder;
use Dazzle\Redis\Command\Enum;
use Dazzle\Redis\Driver\Request;

trait ApiKeyValTrait
{
    /**
     * @param Request $request
     * @return mixed
     */
    abstract function dispatch(Request $request);


    /**
     * @override
     * @inheritDoc
     */
    public function append($key, $value)
    {
        $command = Enum::APPEND;
        $args = [$key, $value];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function bitCount($key, $start = 0, $end = 0)
    {
        $command = Enum::BITCOUNT;
        $args = [$key, $start, $end];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function bitField($key, $subCommand = null, ...$param)

    {
        $command = Enum::BITFIELD;
        switch ($subCommand = strtoupper($subCommand)) {
            case 'GET' : {
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
                list ($type, $offset) = $param;
                $args = [$subCommand, $type, $offset];
                break;
            }
            case 'SET' : {
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
                list ($type, $offset, $value) = $param;
                $args = [$subCommand, $type, $offset, $value];
                break;
            }
            case 'INCRBY' : {
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
                list ($type, $offset, $increment) = $param;
                $args = [$type, $offset, $increment];
                break;
            }
            case 'OVERFLOW' : {
switch ($expr) {
    case "A": { //wrong
        doSomething();
        break;
    }
    case "B"; //wrong
        doSomething();
        break;
    case "C": //right
        doSomething();
        break;
}
                list ($behavior) = $param;
                $args = [$subCommand, $behavior];
                break;
            }
            default : {
switch ($expr) {
    default: { //wrong
        doSomething();
        break;
    }
}

switch ($expr) {
    default: //right
        doSomething();
        break;
}
                $args = [];
                break;
            }
        }
        $args = array_filter($args);

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function bitOp($operation, $dstKey, $srcKey, ...$keys)
    {
        $command = Enum::BITOP;
        $args = [$operation, $dstKey, $srcKey];
        $args = array_merge($args, $keys);

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function bitPos($key, $bit, $start = 0, $end = 0)
    {
        $command = Enum::BITPOS;
        $args = [$key, $bit, $start, $end];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function decr($key)

    {
        // TODO: Implement decr() method.
        $command = Enum::DECR;
        $args = [$key];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function decrBy($key, $decrement)
    {
        // TODO: Implement decrBy() method.
        $command = Enum::DECRBY;
        $args = [$key, $decrement];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function get($key)

    {
        $command = Enum::GET;
        $args = [$key];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function getBit($key, $offset)
    {
        // TODO: Implement getBit() method.
        $command = Enum::GETBIT;
        $args = [$key, $offset];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function getRange($key, $start, $end)
    {
        // TODO: Implement getRange() method.
        $command = Enum::GETRANGE;
        $args = [$key, $start, $end];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function getSet($key, $value)
    {
        // TODO: Implement getSet() method.
        $command = Enum::GETSET;
        $args = [$key, $value];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function incr($key)

    {
        $command = Enum::INCR;
        $args = [$key];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function incrBy($key, $increment)
    {
        // TODO: Implement incrBy() method.
        $command = Enum::INCRBY;
        $args = [$key, $increment];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function incrByFloat($key, $increment)
    {
        // TODO: Implement incrByFloat() method.
        $command = Enum::INCRBYFLOAT;
        $args = [$key, $increment];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function set($key, $value, array $options = [])
    {
        $command = Enum::SET;
        array_unshift($options, $key, $value);
        $args = $options;

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function setBit($key, $offset, $value)
    {
        // TODO: Implement setBit() method.
        $command = Enum::SETBIT;
        $args = [$key, $offset, $value];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function setEx($key, $seconds, $value)
    {
        $command = Enum::SETEX;
        $args = [$key, $seconds, $value];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function setNx($key, $value)
    {
        $command = Enum::SETNX;
        $args = [$key, $value];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function setRange($key, $offset, $value)
    {
        $command = Enum::SETRANGE;
        $args = [$key, $offset, $value];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function pSetEx($key, $milliseconds, $value)
    {
        $command = Enum::PSETEX;
        $args = [$key, $milliseconds, $value];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function mGet($key, ...$values)
    {
        // TODO: Implement mGet() method.
        $command = Enum::MGET;
        $args = [$key];
        $args = array_merge($args, $values);

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function mSet(array $kvMap)
    {
        // TODO: Implement mSet() method.
        $command = Enum::MSET;
        $args = $kvMap;

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function mSetNx($kvMap)
    {
        // TODO: Implement mSetNx() method.
        $command = Enum::MSETNX;
        $args = $kvMap;

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function strLen($key)

    {
        // TODO: Implement strLen() method.
        $command = Enum::STRLEN;
        $args = [$key];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function del($key,...$keys)

    {
        $command = Enum::DEL;
        $keys[] = $key;
        $args = $keys;

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function dump($key)

    {
        // TODO: Implement dump() method.
        $command = Enum::DUMP;
        $args = [$key];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function exists($key, ...$keys)
    {
        // TODO: Implement exists() method.
        $command = Enum::EXISTS;
        $args = [$key];
        $args = array_merge($args, $keys);

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function expire($key, $seconds)
    {
        // TODO: Implement expire() method.
        $command = Enum::EXPIRE;
        $args = [$key, $seconds];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function expireAt($key, $timestamp)
    {
        // TODO: Implement expireAt() method.
        $command = Enum::EXPIREAT;
        $args = [$key, $timestamp];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function persist($key)

    {
        $command = Enum::PERSIST;
        $args = [$key];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function pExpire($key, $milliseconds)
    {
        // TODO: Implement pExpire() method.
        $command = Enum::PEXPIRE;
        $args = [$key, $milliseconds];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function pExpireAt($key, $milliseconds)
    {
        // TODO: Implement pExpireAt() method.
        $command = Enum::PEXPIREAT;
        $args = [$key, $milliseconds];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function touch($key, ...$keys)
    {
        $command = Enum::TOUCH;
        $args = [$key];
        $args = array_merge($args, $keys);

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function ttl($key)

    {
        // TODO: Implement ttl() method.
        $command = Enum::TTL;
        $args = [$key];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function type($key)

    {
        $command = Enum::TYPE;
        $args = [$key];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function unLink($key, ...$keys)
    {
        $command = Enum::UNLINK;
        $args = [$key];
        $args = array_merge($args, $keys);

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function wait($numSlaves, $timeout)
    {
        // TODO: Implement wait() method.
        $command = Enum::WAIT;
        $args = [$numSlaves, $timeout];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function randomKey()
    {
        // TODO: Implement randomKey() method.
        $command = Enum::RANDOMKEY;

        return $this->dispatch(Builder::build($command));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function rename($key, $newKey)
    {
        $command = Enum::RENAME;
        $args = [$key, $newKey];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function renameNx($key, $newKey)
    {
        $command = Enum::RENAMENX;
        $args = [$key, $newKey];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function restore($key, $ttl, $value)
    {
        // TODO: Implement restore() method.
        $command = Enum::RESTORE;
        $args = [$key, $ttl, $value];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function pTtl($key)

    {
        $command = Enum::PTTL;
        $args = [$key];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function move($key, $db)
    {
        // TODO: Implement move() method.
        $command = Enum::MOVE;
        $args = [$key, $db];

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function scan($cursor, array $options = [])
    {
        $command = Enum::SCAN;
        $args = [$cursor];
        $args = array_merge($args, $options);

        return $this->dispatch(Builder::build($command, $args));
    }

    /**
     * @override
     * @inheritDoc
     */
    public function sort($key, array $options = [])
    {
        // TODO: Implement sort() method.
        $command = Enum::SORT;
        $args = [$key];
        $args = array_merge($args, $options);

        return $this->dispatch(Builder::build($command, $args));
    }
}


dazzle-php / redis