TestQueuedJob - Code Metrics - Inspection of "SilverStripe 4.0 Compatability" - silverstripe-australia/silverstripe-queuedjobs - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#125)

unknown

created 2017-04-24 03:59 UTC

TestQueuedJob A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	46
Duplicated Lines	36.96 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes

Metric	Value
wmc	7
lcom	2
cbo	1
dl	17
loc	46
rs	10
c	0
b	0
f	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	2
A	getJobType()	0	4	1
A	getTitle()	0	4	1
A	setup()	0	4	1
A	process()	17	18	2

How to fix Duplicated Code

<?php

namespace SilverStripe\QueuedJobs\Tests\QueuedJobsTest;

use SilverStripe\QueuedJobs\Services\AbstractQueuedJob;
use SilverStripe\QueuedJobs\Services\QueuedJob;

class TestQueuedJob extends AbstractQueuedJob implements QueuedJob
{
    private $type = QueuedJob::QUEUED;

    public function __construct($type = null)
    {
        if ($type) {
            $this->type = $type;
        }
        $this->times = array();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
    }

    public function getJobType()
    {
        return $this->type;
    }

    public function getTitle()
    {
        return "A Test job";
    }

    public function setup()
    {
        $this->totalSteps = 5;
    }

    public function process()

    {
        $times = $this->times;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        // needed due to quirks with __set
        $times[] = date('Y-m-d H:i:s');
        $this->times = $times;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

        $this->addMessage("Updated time to " . date('Y-m-d H:i:s'));
        sleep(1);

        // make sure we're incrementing
        $this->currentStep++;

        // and checking whether we're complete
        if ($this->currentStep == 5) {
            $this->isComplete = true;
        }
    }
}


1		<?php
2
3		namespace SilverStripe\QueuedJobs\Tests\QueuedJobsTest;
4
5		use SilverStripe\QueuedJobs\Services\AbstractQueuedJob;
6		use SilverStripe\QueuedJobs\Services\QueuedJob;
7
8		class TestQueuedJob extends AbstractQueuedJob implements QueuedJob
9		{
10		private $type = QueuedJob::QUEUED;
11
12		public function __construct($type = null)
13		{
14		if ($type) {
15		$this->type = $type;
16		}
17		$this->times = array();
		0 ignored issues – show Documentation introduced 2017-04-24 01:19 UTC by Report Bug Copy Issue Report The property `times` does not exist on `object<SilverStripe\Queu...JobsTest\TestQueuedJob>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
18		}
19
20		public function getJobType()
21		{
22		return $this->type;
23		}
24
25		public function getTitle()
26		{
27		return "A Test job";
28		}
29
30		public function setup()
31		{
32		$this->totalSteps = 5;
33		}
34
35	View Code Duplication	public function process()
		0 ignored issues – show Duplication introduced 2017-04-19 11:21 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...
36		{
37		$times = $this->times;
		0 ignored issues – show Documentation introduced 2017-04-24 01:19 UTC by Report Bug Copy Issue Report The property `times` does not exist on `object<SilverStripe\Queu...JobsTest\TestQueuedJob>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
38		// needed due to quirks with __set
39		$times[] = date('Y-m-d H:i:s');
40		$this->times = $times;
		0 ignored issues – show Documentation introduced 2017-04-24 01:19 UTC by Report Bug Copy Issue Report The property `times` does not exist on `object<SilverStripe\Queu...JobsTest\TestQueuedJob>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
41
42		$this->addMessage("Updated time to " . date('Y-m-d H:i:s'));
43		sleep(1);
44
45		// make sure we're incrementing
46		$this->currentStep++;
47
48		// and checking whether we're complete
49		if ($this->currentStep == 5) {
50		$this->isComplete = true;
51		}
52		}
53		}
54

silverstripe-australia / silverstripe-queuedjobs

Pull Request — master (#125)

TestQueuedJob A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like