AbstractRateLimiter::getLimit() - Code Metrics - Inspection of "Removed wave issue in Reset-At by going to millis" - nikolaposa/rate-limit - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#12)

unknown

created 2018-11-07 13:29 UTC

AbstractRateLimiter::getLimit() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php
/**
 * This file is part of the Rate Limit package.
 *
 * Copyright (c) Nikola Posa
 *
 * For full copyright and license information, please refer to the LICENSE file,
 * located at the package root folder.
 */

declare(strict_types=1);

namespace RateLimit;

use RateLimit\Exception\RateLimitExceededException;

/**
 * @author Nikola Posa <[email protected]>
 */
abstract class AbstractRateLimiter implements RateLimiterInterface
{
    /**
     * @var int
     */
    protected $limit;

    /**
     * @var int
     */
    protected $window;

    /**
     * @var string
     */
    protected $key;

    public function __construct(int $limit, int $window)
    {
        $this->limit = $limit;
        $this->window = $window;
    }

    /**
     * {@inheritdoc}
     */
    public function getLimit() : int
    {
        return $this->limit;
    }

    /**
     * {@inheritdoc}
     */
    public function getWindow() : int
    {
        return $this->window;
    }

    /**
     * {@inheritdoc}
     */
    public function hit(string $key)
    {
        $current = $this->getCurrent($key);

        if ($current >= $this->limit) {
            throw RateLimitExceededException::forKey($key);
        }

        if (0 === $current) {
            $this->init($key);
            return;
        }

        $this->increment($key);
    }

    /**
     * {@inheritdoc}
     */
    public function getRemainingAttempts(string $key) : int
    {
        return max(0, $this->limit - $this->getCurrent($key));
    }

    /**
     * {@inheritdoc}
     */
    public function getResetAt(string $key) : int
    {
        return (int)ceil(microtime(true) + $this->ttl($key))
    }


    protected function getCurrent(string $key) : int
    {
        return $this->get($key, 0);
    }

    abstract protected function get(string $key, int $default) : int;

    abstract protected function init(string $key);

    abstract protected function increment(string $key);

    abstract protected function ttl(string $key) : float;
}


1			<?php
2			/**
3			* This file is part of the Rate Limit package.
4			*
5			* Copyright (c) Nikola Posa
6			*
7			* For full copyright and license information, please refer to the LICENSE file,
8			* located at the package root folder.
9			*/
10
11			declare(strict_types=1);
12
13			namespace RateLimit;
14
15			use RateLimit\Exception\RateLimitExceededException;
16
17			/**
18			* @author Nikola Posa <[email protected]>
19			*/
20			abstract class AbstractRateLimiter implements RateLimiterInterface
21			{
22			/**
23			* @var int
24			*/
25			protected $limit;
26
27			/**
28			* @var int
29			*/
30			protected $window;
31
32			/**
33			* @var string
34			*/
35			protected $key;
36
37			public function __construct(int $limit, int $window)
38			{
39			$this->limit = $limit;
40			$this->window = $window;
41			}
42
43			/**
44			* {@inheritdoc}
45			*/
46			public function getLimit() : int
47			{
48			return $this->limit;
49			}
50
51			/**
52			* {@inheritdoc}
53			*/
54			public function getWindow() : int
55			{
56			return $this->window;
57			}
58
59			/**
60			* {@inheritdoc}
61			*/
62			public function hit(string $key)
63			{
64			$current = $this->getCurrent($key);
65
66			if ($current >= $this->limit) {
67			throw RateLimitExceededException::forKey($key);
68			}
69
70			if (0 === $current) {
71			$this->init($key);
72			return;
73			}
74
75			$this->increment($key);
76			}
77
78			/**
79			* {@inheritdoc}
80			*/
81			public function getRemainingAttempts(string $key) : int
82			{
83			return max(0, $this->limit - $this->getCurrent($key));
84			}
85
86			/**
87			* {@inheritdoc}
88			*/
89			public function getResetAt(string $key) : int
90			{
91			return (int)ceil(microtime(true) + $this->ttl($key))
92			}
			0 ignored issues – show Bug introduced 2018-11-07 13:41 UTC by Report Bug Copy Issue Report This code did not parse for me. Apparently, there is an error somewhere around this line: Syntax error, unexpected '}', expecting ';' Loading history...
93
94			protected function getCurrent(string $key) : int
95			{
96			return $this->get($key, 0);
97			}
98
99			abstract protected function get(string $key, int $default) : int;
100
101			abstract protected function init(string $key);
102
103			abstract protected function increment(string $key);
104
105			abstract protected function ttl(string $key) : float;
106			}
107

nikolaposa / rate-limit

Pull Request — master (#12)

AbstractRateLimiter::getLimit() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like