Output::processTopic() - Code Metrics - Inspection of "Added new tests" - johnnymast/rivescript-php - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( af6300...030a8a )

by Johnny

created 2022-02-24 21:26 UTC

Output::processTopic() B

↳ Parent: Output

Complexity

Conditions	8
Paths	10

Size

Total Lines	81
Code Lines	36

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
eloc	36
nc	10
nop	1
dl	0
loc	81
rs	8.0995
c	0
b	0
f	0

How to fix Long Method

<?php
/*
 * This file is part of Rivescript-php
 *
 * (c) Shea Lewis <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Axiom\Rivescript\Cortex;

use Axiom\Rivescript\Cortex\ResponseQueue\ResponseQueueItem;
use Axiom\Rivescript\Traits\Regex;
use Axiom\Rivescript\Traits\Tags;

/**
 * Output class
 *
 * This class is responsible for generating the
 * bot response.
 *
 * PHP version 7.4 and higher.
 *
 * @category Core
 * @package  Cortext
 * @author   Shea Lewis <[email protected]>
 * @license  https://opensource.org/licenses/MIT MIT
 * @link     https://github.com/axiom-labs/rivescript-php
 * @since    0.3.0
 */
class Output
{

    use Regex;
    use Tags;


    /**
     * The output string
     *
     * @var string
     */
    protected string $output = '';

    /**
     * Keep track of the recursion
     * in the output.
     *
     * @var int
     */
    protected int $recursion = 0;

    /**
     * Process the correct output response by the interpreter.
     *
     * @return string
     */
    public function process(): string
    {
//        $triggers = synapse()->brain->topic()->triggers();
        $begin = synapse()->brain->topic("__begin__");


        $this->output = "";


        /**
         * 1. Check if topic is valid
         * 2. Process the triggers
         * 3. if valid trigger
         *   - Check if response is redirect
         *   -
         */
//        if ($begin) {
//            synapse()->rivescript->say("Begin label found. Starting processing.");
//
//            $request = $begin->triggers()->get("request");
//
//            if ($request) {
//                $this->output = $request['responses']->process();
//
//                if ($begin->isOk() === false) {
//                    return $this->output;
//                }
//            }
//        }


        return $this->processTopic();

        return trim($this->output);
function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}
    }

    protected function processTopic(int $recursion = 0): string
    {
        $topic = synapse()->memory->shortTerm()->get('topic') ?? 'random';

        // synapse()->rivescript->say("TOPIC {$topic}...");
        $triggers = synapse()->brain->topic($topic)->triggers();

        if ($recursion == 200) {
            synapse()->rivescript->warn("Top many recursive calls to :func", ["func" => __CLASS__ . "::" . __FUNCTION__]);
            exit;
interface ReturnsInt {
    public function returnsIntHinted(): int;
}

class MyClass implements ReturnsInt {
    public function returnsIntHinted(): int
    {
        if (foo()) {
            return 123;
        }
        // here: null is implicitly returned
    }
}
        }

        foreach ($triggers as $trigger => $data) {
            $valid = $this->isValidTrigger($trigger);

            if ($valid === true) {
                synapse()->rivescript->debug("Found trigger \":trigger\".", [
                    'trigger' => $trigger,
                ]);

                synapse()->memory->shortTerm()->put('trigger', $trigger);
                $response = $this->getValidResponse($trigger);

                if ($response) {



                    if ($response->isTopicChanged() === true) {
                        synapse()->rivescript->debug(
                            "Topic changed from \":from\" to \":to\"",
                            [
                                "from" => $topic,
                                "to" => synapse()->memory->shortTerm()->get('topic') ?? 'random'
                            ]
                        );

                        synapse()->rivescript->debug(
                            "Parsed trigger :trigger",
                            [
                                "trigger" => $response->getValue(),
                            ]
                        );

                        //     synapse()->memory->shortTerm()->put('trigger', $response->getValue());

                        /**
                         * The topic has changed to something else during $this->getValidResponse($trigger).
                         * Call $this->>processTopic again to process the new topic.
                         *
                         * @note in this case the input can stay the same.
                         */
                        //    return $this->processTopic(++$recursion);
                    }

                    if ($response->isRedirect() === true) {
                        synapse()->rivescript->debug("Found redirect to \":redirect\" current topic is \":topic\".", [
                            "redirect" => $response->getRedirect(),
                            "topic" => $response->getTopic()
                        ]);

                        synapse()->input = new Input($response->getRedirect(), synapse()->rivescript->getClientId());
                        synapse()->memory->shortTerm()->put('trigger', $response->getRedirect());

                        return $this->processTopic(++$recursion);
                    }


                    $output = $response->getValue();

                    if ($output) {
                        $this->output = $output;
                        break;
                    }
                } else {
                    synapse()->rivescript->warn("Could not find a valid response for trigger \":trigger\"", [
                        "trigger" => $trigger
                    ]);
                }
            }
        }

        return trim($this->output);
    }


    /**
     * Search through available triggers to find a possible match.
     *
     * @param string $trigger The trigger to find responses for.
     *
     * @return bool
     */
    protected function isValidTrigger(string $trigger): bool
    {
        $triggers = synapse()->triggers;
        foreach ($triggers as $class) {
            $triggerClass = "\\Axiom\\Rivescript\\Cortex\\Triggers\\{$class}";
            $triggerInstance = new $triggerClass(synapse()->input);

            $found = $triggerInstance->parse($trigger, synapse()->input);

            if ($found) {
                return true;
            }
        }

        return false;
    }

    protected function getValidResponse(string $trigger)
    {
        $originalTrigger = synapse()->brain->topic()->triggers()->get($trigger);
        $queueItem = null;

        if ($originalTrigger['responses']) {
            $queueItem = $originalTrigger['responses']->process();

            if ($queueItem) {
                $queueItem->parse();
            }
        }

        return $queueItem;
    }
}


1			<?php
2			/*
3			* This file is part of Rivescript-php
4			*
5			* (c) Shea Lewis <[email protected]>
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10
11			namespace Axiom\Rivescript\Cortex;
12
13			use Axiom\Rivescript\Cortex\ResponseQueue\ResponseQueueItem;
14			use Axiom\Rivescript\Traits\Regex;
15			use Axiom\Rivescript\Traits\Tags;
16
17			/**
18			* Output class
19			*
20			* This class is responsible for generating the
21			* bot response.
22			*
23			* PHP version 7.4 and higher.
24			*
25			* @category Core
26			* @package Cortext
27			* @author Shea Lewis <[email protected]>
28			* @license https://opensource.org/licenses/MIT MIT
29			* @link https://github.com/axiom-labs/rivescript-php
30			* @since 0.3.0
31			*/
32			class Output
33			{
34
35			use Regex;
36			use Tags;
			0 ignored issues – show Bug introduced 2022-01-16 18:59 UTC by Report Bug Copy Issue Report The trait `Axiom\Rivescript\Traits\Tags` requires the property `$memory` which is not provided by `Axiom\Rivescript\Cortex\Output`. Loading history...
37
38			/**
39			* The output string
40			*
41			* @var string
42			*/
43			protected string $output = '';
44
45			/**
46			* Keep track of the recursion
47			* in the output.
48			*
49			* @var int
50			*/
51			protected int $recursion = 0;
52
53			/**
54			* Process the correct output response by the interpreter.
55			*
56			* @return string
57			*/
58			public function process(): string
59			{
60			// $triggers = synapse()->brain->topic()->triggers();
61			$begin = synapse()->brain->topic("__begin__");
			0 ignored issues – show Unused Code introduced 2022-02-24 21:28 UTC by Report Bug Copy Issue Report The assignment to `$begin` is dead and can be removed. Loading history...
62
63			$this->output = "";
64
65
66			/**
67			* 1. Check if topic is valid
68			* 2. Process the triggers
69			* 3. if valid trigger
70			* - Check if response is redirect
71			* -
72			*/
73			// if ($begin) {
74			// synapse()->rivescript->say("Begin label found. Starting processing.");
75			//
76			// $request = $begin->triggers()->get("request");
77			//
78			// if ($request) {
79			// $this->output = $request['responses']->process();
80			//
81			// if ($begin->isOk() === false) {
82			// return $this->output;
83			// }
84			// }
85			// }
86
87
88			return $this->processTopic();
89
90			return trim($this->output);
			0 ignored issues – show Unused Code introduced 2022-02-09 17:45 UTC by Report Bug Copy Issue Report `return trim($this->output)` is not reachable. This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed. Unreachable code is most often the result of `return`, `die` or `exit` statements that have been added for debug purposes. function fx() { try { doSomething(); return true; } catch (\Exception $e) { return false; } return false; } In the above example, the last `return false` will never be executed, because a return statement has already been met in every possible execution path. Loading history...
91			}
92
93			protected function processTopic(int $recursion = 0): string
94			{
95			$topic = synapse()->memory->shortTerm()->get('topic') ?? 'random';
96
97			// synapse()->rivescript->say("TOPIC {$topic}...");
98			$triggers = synapse()->brain->topic($topic)->triggers();
99
100			if ($recursion == 200) {
101			synapse()->rivescript->warn("Top many recursive calls to :func", ["func" => __CLASS__ . "::" . __FUNCTION__]);
102			exit;
			0 ignored issues – show Bug Best Practice introduced 2022-02-24 21:28 UTC by Report Bug Copy Issue Report In this branch, the function will implicitly return `null` which is incompatible with the type-hinted return `string`. Consider adding a return statement or allowing `null` as return value. For hinted functions/methods where all return statements with the correct type are only reachable via conditions, ?null? gets implicitly returned which may be incompatible with the hinted type. Let?s take a look at an example: interface ReturnsInt { public function returnsIntHinted(): int; } class MyClass implements ReturnsInt { public function returnsIntHinted(): int { if (foo()) { return 123; } // here: null is implicitly returned } } Loading history... Best Practice introduced 2022-02-24 21:28 UTC by Report Bug Copy Issue Report Using `exit` here is not recommended. In general, usage of exit should be done with care and only when running in a scripting context like a CLI script. Loading history...
103			}
104
105			foreach ($triggers as $trigger => $data) {
106			$valid = $this->isValidTrigger($trigger);
107
108			if ($valid === true) {
109			synapse()->rivescript->debug("Found trigger \":trigger\".", [
110			'trigger' => $trigger,
111			]);
112
113			synapse()->memory->shortTerm()->put('trigger', $trigger);
114			$response = $this->getValidResponse($trigger);
115
116			if ($response) {
			0 ignored issues – show Coding Style introduced 2022-02-24 21:28 UTC by Report Bug Copy Issue Report Blank line found at start of control structure Loading history...
117
118
119			if ($response->isTopicChanged() === true) {
120			synapse()->rivescript->debug(
121			"Topic changed from \":from\" to \":to\"",
122			[
123			"from" => $topic,
124			"to" => synapse()->memory->shortTerm()->get('topic') ?? 'random'
125			]
126			);
127
128			synapse()->rivescript->debug(
129			"Parsed trigger :trigger",
130			[
131			"trigger" => $response->getValue(),
132			]
133			);
134
135			// synapse()->memory->shortTerm()->put('trigger', $response->getValue());
136
137			/**
138			* The topic has changed to something else during $this->getValidResponse($trigger).
139			* Call $this->>processTopic again to process the new topic.
140			*
141			* @note in this case the input can stay the same.
142			*/
143			// return $this->processTopic(++$recursion);
144			}
145
146			if ($response->isRedirect() === true) {
147			synapse()->rivescript->debug("Found redirect to \":redirect\" current topic is \":topic\".", [
148			"redirect" => $response->getRedirect(),
149			"topic" => $response->getTopic()
150			]);
151
152			synapse()->input = new Input($response->getRedirect(), synapse()->rivescript->getClientId());
153			synapse()->memory->shortTerm()->put('trigger', $response->getRedirect());
154
155			return $this->processTopic(++$recursion);
156			}
157
158
159			$output = $response->getValue();
160
161			if ($output) {
162			$this->output = $output;
163			break;
164			}
165			} else {
166			synapse()->rivescript->warn("Could not find a valid response for trigger \":trigger\"", [
167			"trigger" => $trigger
168			]);
169			}
170			}
171			}
172
173			return trim($this->output);
174			}
175
176
177			/**
178			* Search through available triggers to find a possible match.
179			*
180			* @param string $trigger The trigger to find responses for.
181			*
182			* @return bool
183			*/
184			protected function isValidTrigger(string $trigger): bool
185			{
186			$triggers = synapse()->triggers;
187			foreach ($triggers as $class) {
188			$triggerClass = "\\Axiom\\Rivescript\\Cortex\\Triggers\\{$class}";
189			$triggerInstance = new $triggerClass(synapse()->input);
190
191			$found = $triggerInstance->parse($trigger, synapse()->input);
192
193			if ($found) {
194			return true;
195			}
196			}
197
198			return false;
199			}
200
201			protected function getValidResponse(string $trigger)
202			{
203			$originalTrigger = synapse()->brain->topic()->triggers()->get($trigger);
204			$queueItem = null;
205
206			if ($originalTrigger['responses']) {
207			$queueItem = $originalTrigger['responses']->process();
208
209			if ($queueItem) {
210			$queueItem->parse();
211			}
212			}
213
214			return $queueItem;
215			}
216			}
217

johnnymast / rivescript-php

Push — master ( af6300...030a8a )

Output::processTopic() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like