Transitions::restart() - Code Metrics - Inspection of "Kernel reworked" - fondbot/framework - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 1.0 ( 12d132...dd1957 )

by Vladimir

created 2017-05-09 23:03 UTC

Transitions::restart() B

↳ Parent: Transitions

Complexity

Conditions	3
Paths	3

Size

Total Lines	24
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	16
CRAP Score	3

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	24
ccs	16
cts	16
cp	1
rs	8.9713
cc	3
eloc	17
nc	3
nop	0
crap	3

<?php

declare(strict_types=1);

namespace FondBot\Conversation\Traits;

use RuntimeException;
use InvalidArgumentException;
use FondBot\Application\Kernel;
use FondBot\Conversation\Intent;
use FondBot\Conversation\Interaction;

trait Transitions
{
    /** @var Kernel */
    protected $kernel;

    /**
     * Whether any transition run.
     *
     * @var bool
     */
    protected $transitioned = false;

    /**
     * Jump to another interaction.
     *
     * @param string $interaction
     *
     * @throws \InvalidArgumentException
     */
    protected function jump(string $interaction): void
    {
        /** @var Interaction $instance */
        $instance = $this->kernel->resolve($interaction);

        if (!$instance instanceof Interaction) {
            throw new InvalidArgumentException('Invalid interaction `'.$interaction.'`');
        }

        // Run interaction
        $this->kernel->converse($instance);

        $this->transitioned = true;
    }

    /**
     * Restart current intent or interaction.
     */
    protected function restart(): void
    {
        switch (true) {
            case $this instanceof Intent:
                $this->kernel->clearContext();


                $this->kernel->converse($this);


                $this->transitioned = true;

                break;
            case $this instanceof Interaction:
                $context = $this->kernel->getContext();

                $context->setInteraction(null);
                $context->setValues([]);
                $this->kernel->setContext($context);
/** @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);
    }
}

                $this->transitioned = true;


                $this->kernel->converse($this);

                break;
            default:
                throw new RuntimeException('Only conversable instances can be restarted.');
        }
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace FondBot\Conversation\Traits;
6
7		use RuntimeException;
8		use InvalidArgumentException;
9		use FondBot\Application\Kernel;
10		use FondBot\Conversation\Intent;
11		use FondBot\Conversation\Interaction;
12
13		trait Transitions
14		{
15		/** @var Kernel */
16		protected $kernel;
17
18		/**
19		* Whether any transition run.
20		*
21		* @var bool
22		*/
23		protected $transitioned = false;
24
25		/**
26		* Jump to another interaction.
27		*
28		* @param string $interaction
29		*
30		* @throws \InvalidArgumentException
31		*/
32	3	protected function jump(string $interaction): void
33		{
34		/** @var Interaction $instance */
35	3	$instance = $this->kernel->resolve($interaction);
36
37	3	if (!$instance instanceof Interaction) {
38	2	throw new InvalidArgumentException('Invalid interaction `'.$interaction.'`');
39		}
40
41		// Run interaction
42	1	$this->kernel->converse($instance);
43
44	1	$this->transitioned = true;
45	1	}
46
47		/**
48		* Restart current intent or interaction.
49		*/
50	3	protected function restart(): void
51		{
52		switch (true) {
53	3	case $this instanceof Intent:
54	1	$this->kernel->clearContext();
		0 ignored issues – show Bug introduced 2017-05-09 23:09 UTC by Report Bug Copy Issue Report The property `kernel` cannot be accessed from this context as it is declared `protected` in class `FondBot\Conversation\Traits\InteractsWithContext`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
55
56	1	$this->kernel->converse($this);
		0 ignored issues – show Bug introduced 2017-05-09 23:09 UTC by Report Bug Copy Issue Report The property `kernel` cannot be accessed from this context as it is declared `protected` in class `FondBot\Conversation\Traits\InteractsWithContext`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
57
58	1	$this->transitioned = true;
		0 ignored issues – show Bug introduced 2017-05-09 23:09 UTC by Report Bug Copy Issue Report The property `transitioned` cannot be accessed from this context as it is declared `protected` in class `FondBot\Conversation\Traits\Transitions`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
59	1	break;
60	1	case $this instanceof Interaction:
61	1	$context = $this->kernel->getContext();
		0 ignored issues – show Bug introduced 2017-05-09 23:09 UTC by Report Bug Copy Issue Report The property `kernel` cannot be accessed from this context as it is declared `protected` in class `FondBot\Conversation\Traits\InteractsWithContext`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
62	1	$context->setInteraction(null);
63	1	$context->setValues([]);
64	1	$this->kernel->setContext($context);
		0 ignored issues – show Bug introduced 2017-05-09 23:09 UTC by Report Bug Copy Issue Report The property `kernel` cannot be accessed from this context as it is declared `protected` in class `FondBot\Conversation\Traits\InteractsWithContext`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history... Bug introduced 2017-05-09 23:09 UTC by Report Bug Copy Issue Report It seems like `$context` defined by `$this->kernel->getContext()` on line `61` can be `null`; however, `FondBot\Application\Kernel::setContext()` 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...
65
66	1	$this->transitioned = true;
		0 ignored issues – show Bug introduced 2017-05-09 23:09 UTC by Report Bug Copy Issue Report The property `transitioned` cannot be accessed from this context as it is declared `protected` in class `FondBot\Conversation\Traits\Transitions`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
67
68	1	$this->kernel->converse($this);
		0 ignored issues – show Bug introduced 2017-05-09 23:09 UTC by Report Bug Copy Issue Report The property `kernel` cannot be accessed from this context as it is declared `protected` in class `FondBot\Conversation\Traits\InteractsWithContext`. This check looks for access to properties that are not accessible from the current context. If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class. Loading history...
69	1	break;
70		default:
71	1	throw new RuntimeException('Only conversable instances can be restarted.');
72		}
73	2	}
74		}
75

fondbot / framework

Push — 1.0 ( 12d132...dd1957 )

Transitions::restart() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like