LongPolling - Code Metrics - Inspection of "Fix namespace issue" - DanySpin97/PhpBotFramework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#20)

unknown

created 2017-01-19 16:23 UTC

LongPolling A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	217
Duplicated Lines	13.36 %

Coupling/Cohesion

Components	3
Dependencies	0

Importance

Changes

Metric	Value
wmc	20
lcom	3
cbo	0
dl	29
loc	217
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Duplication	Size	Complexity
B	getUpdatesRedis()	16	59	7
B	getUpdatesLocal()	0	54	5
C	getUpdatesDatabase()	13	68	8

How to fix Duplicated Code

<?php

namespace PhpBotFramework\Core;

trait LongPolling {

    /**
     * \brief Get updates received by the bot, using redis to save and get the last offset.
     * \details It check if an offset exists on redis, then get it, or call getUpdates to set it.
     * Then it start an infinite loop where it process updates and update the offset on redis.
     * Each update is surrounded by a try/catch.
     * @see getUpdates
     * @param $limit <i>Optional</i>. Limits the number of updates to be retrieved. Values between 1—100 are accepted.
     * @param $timeout <i>Optional</i>. Timeout in seconds for long polling.
     * @param $offset_key <i>Optional</i>. Name of the variable where the offset is saved on Redis
     */
    public function getUpdatesRedis(int $limit = 100, int $timeout = 60, string $offset_key = 'offset') {


        // Check redis connection
        if (!isset($this->redis)) {

            throw new BotException("Redis connection is not set");

        }

        // If offset is already set in redis
        if ($this->redis->exists($variable_name)) {

            // just set $offset as the same value
            $offset = $this->redis->get($variable_name);
class MyClass { }

$x = new MyClass();
$x->foo = true;

        } else {

            // Else get the offset from the id from the first update received

            do {

                $update = $this->getUpdates(0, 1);


            } while (empty($update));

            $offset = $update[0]['update_id'];

            $this->redis->set($variable_name, $offset);

            $update = null;

        }

        $this->initBot();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        // Process all updates received
        while (true) {

            $updates = $this->getUpdates($offset, $limit, $timeout);


            // Parse all updates received
            foreach ($updates as $key => $update) {

                try {

                    $this->processUpdate($update);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

                } catch (BotException $e) {


                    echo $e->getMessage();

                }

            }

            // Update the offset in redis
            $this->redis->set($variable_name, $offset + count($updates));
        }

    }

    /**
     * \brief Get updates received by the bot, and hold the offset in $offset.
     * \details Get the update_id of the first update to parse, set it in $offset and
     * then it start an infinite loop where it processes updates and keep $offset on the update_id of the last update received.
     * Each processUpdate() method call is surrounded by a try/catch.
     * @see getUpdates
     * @param $limit <i>Optional</i>. Limits the number of updates to be retrieved. Values between 1—100 are accepted.
     * @param $timeout <i>Optional</i>. Timeout in seconds for long polling.
     */
    public function getUpdatesLocal(int $limit = 100, int $timeout = 60) {

        $update = [];
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        // While there aren't updates to process
        do {

            // Get updates from telegram
            $update = $this->getUpdates(0, 1);


            // While in the array received there aren't updates
        } while (empty($update));

        // Set the offset to the first update recevied
        $offset = $update[0]['update_id'];

        $update = null;

        $this->initBot();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        // Process all updates
        while (true) {

            // Set parameter for the url call
            $parameters = [
                'offset' => $offset,
                'limit' => $limit,
                'timeout' => $timeout
            ];

            $updates = $this->exec_curl_request($this->_api_url . 'getUpdates?' . http_build_query($parameters));
class MyClass { }

$x = new MyClass();
$x->foo = true;

            // Parse all update to receive
            foreach ($updates as $key => $update) {

                try {

                    // Process one at a time
                    $this->processUpdate($update);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

                } catch (BotException $e) {


                    echo $e->getMessage();

                }

            }

            // Update the offset
            $offset += sizeof($updates);

        }

    }

    /**
     * \brief Get updates received by the bot, using the sql database to store and get the last offset.
     * \details It check if an offset exists on redis, then get it, or call getUpdates to set it.
     * Then it start an infinite loop where it process updates and update the offset on redis.
     * Each update is surrounded by a try/catch.
     * @see getUpdates
     * @param $limit <i>Optional</i>. Limits the number of updates to be retrieved. Values between 1—100 are accepted.
     * @param $timeout <i>Optional</i>. Timeout in seconds for long polling.
     * @param $table_name <i>Optional</i>. Name of the table where offset is saved in the database
     * @param $column_name <i>Optional</i>. Name of the column where the offset is saved in the database
     */
    public function getUpdatesDatabase(int $limit = 100, int $timeout = 0, string $table_name = 'telegram', string $column_name = 'bot_offset') {

        if (!isset($this->_database)) {

            throw new BotException("Database connection is not set");

        }

        // Get the offset from the database
        $sth = $this->pdo->prepare('SELECT ' . $column_name . ' FROM ' . $table_name);
class MyClass { }

$x = new MyClass();
$x->foo = true;

        try {

            $sth->execute();

        } catch (PDOException $e) {


            echo $e->getMessage();

        }

        $offset = $sth->fetchColumn();
        $sth = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

        // Get the offset from the first update to update
        if ($offset === false) {


            do {

                $update = $this->getUpdates(0, 1);


            } while (empty($update));

            $offset = $update[0]['update_id'];

            $update = null;

        }

        // Prepare the query for updating the offset in the database
        $sth = $this->pdo->prepare('UPDATE "' . $table_name . '" SET "' . $column_name . '" = :new_offset');

        $this->initBot();
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        while (true) {

            $updates = $this->getUpdates($offset, $limit, $timeout);


            foreach ($updates as $key => $update) {

                try {

                    $this->processUpdate($update);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

                } catch (BotException $e) {


                    echo $e->getMessage();

                }

            }

            // Update the offset on the database
            $sth->bindParam(':new_offset', $offset + sizeof($updates));
            $sth->execute();

        }
    }

}


1		<?php
2
3		namespace PhpBotFramework\Core;
4
5		trait LongPolling {
6
7		/**
8		* \brief Get updates received by the bot, using redis to save and get the last offset.
9		* \details It check if an offset exists on redis, then get it, or call getUpdates to set it.
10		* Then it start an infinite loop where it process updates and update the offset on redis.
11		* Each update is surrounded by a try/catch.
12		* @see getUpdates
13		* @param $limit <i>Optional</i>. Limits the number of updates to be retrieved. Values between 1—100 are accepted.
14		* @param $timeout <i>Optional</i>. Timeout in seconds for long polling.
15		* @param $offset_key <i>Optional</i>. Name of the variable where the offset is saved on Redis
16		*/
17		public function getUpdatesRedis(int $limit = 100, int $timeout = 60, string $offset_key = 'offset') {
		0 ignored issues – show Unused Code introduced 2017-01-18 12:15 UTC by Report Bug Copy Issue Report The parameter `$offset_key` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
18
19		// Check redis connection
20		if (!isset($this->redis)) {
21
22		throw new BotException("Redis connection is not set");
23
24		}
25
26		// If offset is already set in redis
27		if ($this->redis->exists($variable_name)) {
28
29		// just set $offset as the same value
30		$offset = $this->redis->get($variable_name);
		0 ignored issues – show Bug introduced 2017-01-18 12:15 UTC by Report Bug Copy Issue Report The property `redis` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history... Bug introduced 2017-01-18 12:15 UTC by Report Bug Copy Issue Report The variable `$variable_name` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
31
32	View Code Duplication	} else {
		0 ignored issues – show Duplication introduced 2017-01-18 12:15 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
33		// Else get the offset from the id from the first update received
34
35		do {
36
37		$update = $this->getUpdates(0, 1);

DanySpin97 / PhpBotFramework

Pull Request — master (#20)

LongPolling A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

How to fix Duplicated Code

Duplicated Code

Duplication Side-by-Side

Filter issues like