ConversationManager - Code Metrics - Inspection of "Migrating to Illuminate Components" - fondbot/framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( afce1d...f8221d )

by Vladimir

created 2017-07-25 11:14 UTC

ConversationManager A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	118
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

100%

Importance

Changes

Metric	Value
dl	0
loc	118
ccs	43
cts	43
cp	1
rs	10
c	0
b	0
f	0
wmc	12
lcom	1
cbo	5

6 Methods

Rating	Name	Size	Complexity
A	handle()	19	3
A	converse()	16	3
A	transition()	5	1
A	restart()	20	3
A	findIntent()	7	1
A	isInConversation()	4	1

<?php

declare(strict_types=1);

namespace FondBot\Conversation;

use FondBot\Drivers\ReceivedMessage;

class ConversationManager
{
    /**
     * Determine if conversation transitioned.
     *
     * @var bool
     */
    private $transitioned = false;

    /**
     * Handle received message.
     *
     * @param ReceivedMessage $message
     */
    public function handle(ReceivedMessage $message): void
    {
        if (!$this->isInConversation()) {
            $this->converse(
                $this->findIntent($message)
/** @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);
    }
}
            );
        } else {
            $this->converse(
                session()->getInteraction()
/** @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);
    }
}
            );
        }

        // Close session if conversation has not been transitioned
        // Otherwise, save session state
        if (!$this->transitioned) {
            kernel()->closeSession();
            kernel()->clearContext();
        }
    }

    /**
     * Start conversation.
     *
     * @param Conversable|mixed $conversable
     */
    public function converse(Conversable $conversable): void
    {
        if ($conversable instanceof Intent) {
            $session = kernel()->getSession();
            $session->setIntent($conversable);
            $session->setInteraction(null);

            kernel()->setSession($session);

            $conversable->handle();
        } elseif ($conversable instanceof Interaction) {
            $conversable->handle();
        } else {
            $conversable->handle();
        }
    }

    /**
     * Transition to intent or interaction.
     *
     * @param Conversable $conversable
     */
    public function transition(Conversable $conversable): void
    {
        $this->converse($conversable);
        $this->transitioned = true;
    }

    /**
     * Restart intent or interaction.
     *
     * @param Conversable|mixed $conversable
     */
    public function restart(Conversable $conversable): void
    {
        switch (true) {
            case $conversable instanceof Intent:
                $this->converse($conversable);

                $this->transitioned = true;
                break;
            case $conversable instanceof Interaction:
                $session = kernel()->getSession();
                $session->setInteraction(null);

                kernel()->setSession($session);

                $this->transitioned = true;

                $this->converse($conversable);
                break;
        }
    }

    /**
     * Find matching intent.
     *
     * @param ReceivedMessage $message
     *
     * @return Intent|null
     */
    private function findIntent(ReceivedMessage $message): Intent
    {
        /** @var IntentManager $intentManager */
        $intentManager = kernel()->resolve(IntentManager::class);

        return $intentManager->find($message);
    }

    /**
     * Determine if conversation started.
     *
     * @return bool
     */
    private function isInConversation(): bool
    {
        return kernel()->getSession()->getInteraction() !== null;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace FondBot\Conversation;
6
7		use FondBot\Drivers\ReceivedMessage;
8
9		class ConversationManager
10		{
11		/**
12		* Determine if conversation transitioned.
13		*
14		* @var bool
15		*/
16		private $transitioned = false;
17
18		/**
19		* Handle received message.
20		*
21		* @param ReceivedMessage $message
22		*/
23	2	public function handle(ReceivedMessage $message): void
24		{
25	2	if (!$this->isInConversation()) {
26	1	$this->converse(
27	1	$this->findIntent($message)
		0 ignored issues – show Bug introduced 2017-06-27 13:48 UTC by Report Bug Copy Issue Report It seems like `$this->findIntent($message)` can be `null`; however, `converse()` 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...
28		);
29		} else {
30	1	$this->converse(
31	1	session()->getInteraction()
		0 ignored issues – show Bug introduced 2017-05-25 11:49 UTC by Report Bug Copy Issue Report It seems like `session()->getInteraction()` can be `null`; however, `converse()` 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...
32		);
33		}
34
35		// Close session if conversation has not been transitioned
36		// Otherwise, save session state
37	2	if (!$this->transitioned) {
38	2	kernel()->closeSession();
39	2	kernel()->clearContext();
40		}
41	2	}
42
43		/**
44		* Start conversation.
45		*
46		* @param Conversable\|mixed $conversable
47		*/
48	5	public function converse(Conversable $conversable): void
49		{
50	5	if ($conversable instanceof Intent) {
51	2	$session = kernel()->getSession();
52	2	$session->setIntent($conversable);
53	2	$session->setInteraction(null);
54
55	2	kernel()->setSession($session);
56
57	2	$conversable->handle();
58	3	} elseif ($conversable instanceof Interaction) {
59	2	$conversable->handle();
60		} else {
61	1	$conversable->handle();
62		}
63	5	}
64
65		/**
66		* Transition to intent or interaction.
67		*
68		* @param Conversable $conversable
69		*/
70	1	public function transition(Conversable $conversable): void
71		{
72	1	$this->converse($conversable);
73	1	$this->transitioned = true;
74	1	}
75
76		/**
77		* Restart intent or interaction.
78		*
79		* @param Conversable\|mixed $conversable
80		*/
81	2	public function restart(Conversable $conversable): void
82		{
83		switch (true) {
84	2	case $conversable instanceof Intent:
85	1	$this->converse($conversable);
86
87	1	$this->transitioned = true;
88	1	break;
89	1	case $conversable instanceof Interaction:
90	1	$session = kernel()->getSession();
91	1	$session->setInteraction(null);
92
93	1	kernel()->setSession($session);
94
95	1	$this->transitioned = true;
96
97	1	$this->converse($conversable);
98	1	break;
99		}
100	2	}
101
102		/**
103		* Find matching intent.
104		*
105		* @param ReceivedMessage $message
106		*
107		* @return Intent\|null
108		*/
109	1	private function findIntent(ReceivedMessage $message): Intent
110		{
111		/** @var IntentManager $intentManager */
112	1	$intentManager = kernel()->resolve(IntentManager::class);
113
114	1	return $intentManager->find($message);
115		}
116
117		/**
118		* Determine if conversation started.
119		*
120		* @return bool
121		*/
122	2	private function isInConversation(): bool
123		{
124	2	return kernel()->getSession()->getInteraction() !== null;
125		}
126		}
127

fondbot / framework

Push — master ( afce1d...f8221d )

ConversationManager A

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

6 Methods

Duplication Side-by-Side

Filter issues like