MemcachedRateLimiter::updateCounter() - Code Metrics - Inspection of "new limiters" - nikolaposa/rate-limit - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#24)

by Julián

created 2020-05-09 00:12 UTC

MemcachedRateLimiter::updateCounter() A

↳ Parent: MemcachedRateLimiter

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	10
ccs	5
cts	5
cp	1
rs	9.9332
c	0
b	0
f	0
cc	3
nc	4
nop	3
crap	3

<?php

declare(strict_types=1);

namespace RateLimit;

use Memcached;

final class MemcachedRateLimiter extends AbstractElapsedTimeRateLimiter
{
    private const MEMCACHED_SECONDS_LIMIT = 2592000; // Number of seconds in 30 days

    /** @var Memcached */
    private $memcached;

    public function __construct(Memcached $memcached, string $keyPrefix = '')
    {
        if ($memcached->getOption(Memcached::OPT_BINARY_PROTOCOL) !== 1) {
            throw new \RuntimeException('Memcached "OPT_BINARY_PROTOCOL" option should be set to "true".');
        }

        parent::__construct($keyPrefix);

        $this->memcached = $memcached;
    }

    protected function getCurrent(string $valueKey): int
    {
        return (int) $this->memcached->get($valueKey);
    }

    protected function updateCounter(string $valueKey, string $timeKey, int $interval): int
    {
        $current = $this->memcached->increment($valueKey, 1, 1, $this->intervalToMemcachedTime($interval));

        if ($current === 1) {
            $this->memcached->add($timeKey, \time(), $this->intervalToMemcachedTime($interval));
        }

        return $current === false ? 1 : $current;
    }

    protected function getElapsedTime(string $timeKey): int
    {
        return \time() - (int) $this->memcached->get($timeKey);
    }

    /**
     * Interval to Memcached expiration time.
     *
     * @see https://www.php.net/manual/en/memcached.expiration.php
     *
     * @param int $interval
     *
     * @return int
     */
    private function intervalToMemcachedTime(int $interval): int
    {
        return $interval <= self::MEMCACHED_SECONDS_LIMIT ? $interval : \time() + $interval;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace RateLimit;
6
7		use Memcached;
8
9		final class MemcachedRateLimiter extends AbstractElapsedTimeRateLimiter
10		{
11		private const MEMCACHED_SECONDS_LIMIT = 2592000; // Number of seconds in 30 days
12
13		/** @var Memcached */
14		private $memcached;
15
16	5	public function __construct(Memcached $memcached, string $keyPrefix = '')
17		{
18	5	if ($memcached->getOption(Memcached::OPT_BINARY_PROTOCOL) !== 1) {
19		throw new \RuntimeException('Memcached "OPT_BINARY_PROTOCOL" option should be set to "true".');
20		}
21
22	5	parent::__construct($keyPrefix);
23
24	5	$this->memcached = $memcached;
25	5	}
26
27	5	protected function getCurrent(string $valueKey): int
28		{
29	5	return (int) $this->memcached->get($valueKey);
30		}
31
32	5	protected function updateCounter(string $valueKey, string $timeKey, int $interval): int
33		{
34	5	$current = $this->memcached->increment($valueKey, 1, 1, $this->intervalToMemcachedTime($interval));
35
36	5	if ($current === 1) {
37	5	$this->memcached->add($timeKey, \time(), $this->intervalToMemcachedTime($interval));
38		}
39
40	5	return $current === false ? 1 : $current;
41		}
42
43	3	protected function getElapsedTime(string $timeKey): int
44		{
45	3	return \time() - (int) $this->memcached->get($timeKey);
46		}
47
48		/**
49		* Interval to Memcached expiration time.
50		*
51		* @see https://www.php.net/manual/en/memcached.expiration.php
52		*
53		* @param int $interval
54		*
55		* @return int
56		*/
57	5	private function intervalToMemcachedTime(int $interval): int
58		{
59	5	return $interval <= self::MEMCACHED_SECONDS_LIMIT ? $interval : \time() + $interval;
60		}
61		}
62

nikolaposa / rate-limit

Pull Request — master (#24)

MemcachedRateLimiter::updateCounter() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like