ContractCheckerAspect::invariantContract() - Code Metrics - Inspection of "Contract propagation for subclasses" - php-deal/framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#10)

unknown

created 2016-03-30 19:20 UTC

ContractCheckerAspect::invariantContract() A

↳ Parent: ContractCheckerAspect

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	8
Bugs	1	Features	1

Metric	Value
c	8
b	1
f	1
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
cc	1
eloc	2
nc	1
nop	1
crap	1

<?php
/**
 * PHP Deal framework
 *
 * @copyright Copyright 2014, Lisachenko Alexander <[email protected]>
 *
 * This source file is subject to the license that is bundled
 * with this source code in the file LICENSE.
 */

namespace PhpDeal\Aspect;

use Doctrine\Common\Annotations\Reader;
use Go\Aop\Aspect;
use Go\Aop\Intercept\MethodInvocation;
use Go\Lang\Annotation\Around;
use Go\Lang\Annotation\Before;
use PhpDeal\Annotation as Contract;
use PhpDeal\Contract\InvariantContract;
use PhpDeal\Contract\PostconditionContract;
use PhpDeal\Contract\PreconditionContract;
use PhpDeal\Exception\ContractViolation;

class ContractCheckerAspect implements Aspect
{
    /**
     * Annotation reader
     *
     * @var Reader|null
     */
    private $reader = null;

    /**
     * Default constructor
     *
     * @param Reader $reader Annotation reader
     */
    public function __construct(Reader $reader)
    {
        $this->reader = $reader;
    }

    /**
     * Verifies pre-condition contract for the method
     *
     * @param MethodInvocation $invocation
     * @Before("@execution(PhpDeal\Annotation\Verify)")
     *
     * @throws ContractViolation
     */
    public function preConditionContract(MethodInvocation $invocation)
    {
        (new PreconditionContract($this->reader))->check($invocation);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
    }

    /**
     * Verifies post-condition contract for the method
     *
     * @Around("@execution(PhpDeal\Annotation\Ensure)")
     * @param MethodInvocation $invocation
     *
     * @throws ContractViolation
     * @return mixed
     */
    public function postConditionContract(MethodInvocation $invocation)
    {
        return (new PostconditionContract($this->reader))->check($invocation);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
    }

    /**
     * Verifies invariants for contract class
     *
     * @Around("@within(PhpDeal\Annotation\Invariant) && execution(public **->*(*))")
     * @param MethodInvocation $invocation
     *
     * @throws ContractViolation
     * @return mixed
     */
    public function invariantContract(MethodInvocation $invocation)
    {
        return (new InvariantContract($this->reader))->check($invocation);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
    }
}


1		<?php
2		/**
3		* PHP Deal framework
4		*
5		* @copyright Copyright 2014, Lisachenko Alexander <[email protected]>
6		*
7		* This source file is subject to the license that is bundled
8		* with this source code in the file LICENSE.
9		*/
10
11		namespace PhpDeal\Aspect;
12
13		use Doctrine\Common\Annotations\Reader;
14		use Go\Aop\Aspect;
15		use Go\Aop\Intercept\MethodInvocation;
16		use Go\Lang\Annotation\Around;
17		use Go\Lang\Annotation\Before;
18		use PhpDeal\Annotation as Contract;
19		use PhpDeal\Contract\InvariantContract;
20		use PhpDeal\Contract\PostconditionContract;
21		use PhpDeal\Contract\PreconditionContract;
22		use PhpDeal\Exception\ContractViolation;
23
24		class ContractCheckerAspect implements Aspect
25		{
26		/**
27		* Annotation reader
28		*
29		* @var Reader\|null
30		*/
31		private $reader = null;
32
33		/**
34		* Default constructor
35		*
36		* @param Reader $reader Annotation reader
37		*/
38		public function __construct(Reader $reader)
39		{
40		$this->reader = $reader;
41		}
42
43		/**
44		* Verifies pre-condition contract for the method
45		*
46		* @param MethodInvocation $invocation
47		* @Before("@execution(PhpDeal\Annotation\Verify)")
48		*
49		* @throws ContractViolation
50		*/
51	19	public function preConditionContract(MethodInvocation $invocation)
52		{
53	19	(new PreconditionContract($this->reader))->check($invocation);
		0 ignored issues – show Bug introduced 2016-03-30 19:23 UTC by Report Bug Copy Issue Report It seems like `$this->reader` can be `null`; however, `__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
54	6	}
55
56		/**
57		* Verifies post-condition contract for the method
58		*
59		* @Around("@execution(PhpDeal\Annotation\Ensure)")
60		* @param MethodInvocation $invocation
61		*
62		* @throws ContractViolation
63		* @return mixed
64		*/
65	8	public function postConditionContract(MethodInvocation $invocation)
66		{
67	8	return (new PostconditionContract($this->reader))->check($invocation);
		0 ignored issues – show Bug introduced 2016-03-30 19:23 UTC by Report Bug Copy Issue Report It seems like `$this->reader` can be `null`; however, `__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
68		}
69
70		/**
71		* Verifies invariants for contract class
72		*
73		* @Around("@within(PhpDeal\Annotation\Invariant) && execution(public *->(*))")
74		* @param MethodInvocation $invocation
75		*
76		* @throws ContractViolation
77		* @return mixed
78		*/
79	7	public function invariantContract(MethodInvocation $invocation)
80		{
81	7	return (new InvariantContract($this->reader))->check($invocation);
		0 ignored issues – show Bug introduced 2016-03-30 19:23 UTC by Report Bug Copy Issue Report It seems like `$this->reader` can be `null`; however, `__construct()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
82		}
83		}
84

php-deal / framework

Pull Request — master (#10)

ContractCheckerAspect::invariantContract() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like