Projectmentor\Quota\PeriodicQuota

Complexity

Total Complexity

14

Size/Duplication

Total Lines	206
Duplicated Lines	12.62 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

83.54%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	getStats()	0	7	1
A	getTimezone()	0	4	1
A	getLogTable()	0	4	1
A	setTimezone()	0	4	1
A	setLogTable()	0	4	1
B	__construct()	0	32	3
A	enforce()	0	4	1
A	dateInTimezone()	0	6	1
A	hit()	13	13	1
A	miss()	13	13	1
A	consume()	0	19	2

<?php

/**
 * This file is part of laravel-quota
 *
 * (c) David Faith <david@projectmentor.org>
 *
 * Full copyright and license information is available
 * in the LICENSE file distributed with this source code.
 */

namespace Projectmentor\Quota;

use DB;
use Carbon\Carbon;

/**
 * This is the periodic quota class.
 * It is used to limit access to a resource
 * over a defined period of time.
 *
 * NOTE: Currently only supports daily quota
 * period. i.e. $this->period = 'day'
 *
 * TODO: REFACTOR for different period types.
 * @See constants in bandwidthThrottle\tokenBucket\Rate.php
 * for allowed period types.
 */

class PeriodicQuota extends Quota

The property $log_table is not named in camelCase.

{
    /**
     * The timezone authority.
     * Used to roll the log records in the database.
     *
     * @var string
     */
    protected $timezone;

    /**
     * The database table name
     *
     * @var string
     */
    protected $log_table;

$log_table does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    /**
     *  Construct instance.
     *
     *  @param string $connection
     *  @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct($connection)
    {
        parent::__construct($connection);

        $this->connection = $connection;
        $this->index = 'quota.connections.' . $connection;

Equals sign not aligned with surrounding assignments; expected 6 spaces but found 1 space

        $this->timezone = config($this->index . '.timezone');
        if (is_null($this->timezone)) {
            $this->timezone = config('quota.default_timezone');
        }

        $this->log_table = config($this->index . '.log_table');

        //Bootstrap log if record does not exist.
        $dtz = new \DateTimeZone($this->timezone);

Equals sign not aligned with surrounding assignments; expected 9 spaces but found 1 space

        $now = new \DateTime(date("Y-m-d"), $dtz);

Equals sign not aligned with surrounding assignments; expected 9 spaces but found 1 space

The string literal Y-m-d does not require double quotes, as per coding-style, please use single quotes.

        $date = $now->format("Y-m-d");

Equals sign not aligned with surrounding assignments; expected 8 spaces but found 1 space

The string literal Y-m-d does not require double quotes, as per coding-style, please use single quotes.

        $log_records = DB::select(

$log_records does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            'SELECT * FROM' .
            ' ' .  $this->log_table .
            ' WHERE date = ' . '\'' . $date . '\'' .
            '  AND connection = ' . '\'' . $connection . '\''
        );

        if (empty($log_records)) {

$log_records does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

            \Artisan::call('quota:reset', [
                'date' => $date,
                'connection' =>  $connection
            ]);
        }
    }

    public function enforce()
    {
        return $this->consume();
    }

    /**
     * Helper.
     *
     * TODO: make static?
     *
     * @param PeriodicQuota $quota

There is no parameter named $quota. Was it maybe removed?

     * @return string
     */
    public function dateInTimezone()
    {
        $dtz = new \DateTimeZone($this->getTimezone());
        $now = new \DateTime(date("Y-m-d"), $dtz);

The string literal Y-m-d does not require double quotes, as per coding-style, please use single quotes.

        return($now->format("Y-m-d"));

The string literal Y-m-d does not require double quotes, as per coding-style, please use single quotes.

    }

    /**
     * Hiiiiit iiiiiit ! :)
     * Record a hit in the log table.
     *
     * @param int $hits so far
     * @return void
     */
    public function hit($hits)

This method seems to be duplicated in your project.

    {
        $date = $this->dateInTimezone();
        $hits = $hits + 1;

Consider using a different name than the parameter $hits. This often makes code more readable.

        DB::statement(
            'UPDATE ' . $this->log_table .
            ' SET hits = ' . $hits .
            ', updated_at = ' . '\'' . Carbon::now()->toDateTimeString() . '\'' .
            ' WHERE date = ' . '\'' . $date . '\'' .
            ' AND connection = ' . '\'' . $this->connection . '\''
        );
    }

    /**
     * Record a miss in the log table.
     *
     * @param int $misses so far
     * @return void
     */
    public function miss($misses)

This method seems to be duplicated in your project.

    {
        $date = $this->dateInTimezone();

Equals sign not aligned with surrounding assignments; expected 3 spaces but found 1 space

        $misses = $misses + 1;

Consider using a different name than the parameter $misses. This often makes code more readable.

        DB::statement(
            'UPDATE ' . $this->log_table .
            ' SET misses = ' . $misses .
            ', updated_at = ' . '\'' . Carbon::now()->toDateTimeString() . '\'' .
            ' WHERE date = ' . '\'' . $date . '\'' .
            ' AND connection = ' . '\'' . $this->connection . '\''
        );
    }

    /**
     * Attempt to... HIT dat a$$!  :)
     *
     * @param integer $tokens future use.
     * @return boolean true on success
     *
     * @throws ErrorException
     */
    public function consume($tokens = 1)

function consume() does not seem to conform to the naming convention (^(?:is|has|should|may|supports)).

The parameter $tokens is not used and could be removed.

    {
        $date = $this->dateInTimezone();

        $stats = $this->getStats($date);
        $hits = (integer) $stats->hits;

Equals sign not aligned with surrounding assignments; expected 2 spaces but found 1 space

        if ($this->limit < ($hits + 1)) {
            $this->miss($stats->misses);
            throw new \ErrorException(
                __CLASS__ . '::' . __FUNCTION__ .
                ' Overquota. Exceeded daily limit: ' . $this->limit
            );
        } else {
            $this->hit($stats->hits);
            $result = true;
        }
         return isset($result);
    }

    /**
     * Get statistics from log table.
     *
     * TODO: REFACTOR rename `date` to `period`
     * to reflect ability to track different periodic
     * limits.
     *
     * @param string $date
     * @return stdObject
     * @throws Exception
     */
    public function getStats($date)
    {
        return DB::table('quotalog')
           ->where('date', $date)
           ->where('connection', $this->connection)
           ->first();
    }

    /**
     * Get the timezone
     *
     * @return string
     */
    public function getTimezone()
    {
        return $this->timezone;
    }

    /**
     * Get the log table name
     *
     * @return string
     */
    public function getLogTable()
    {
        return $this->log_table;
    }

    /**
     * Set the timezone authority
     *
     * @param string
     * @return void
     */
    public function setTimezone($timezone)
    {
        $this->timezone = $timezone;
    }

    /**
     * Set the log_table name
     *
     * @param string
     * @return void
     */
    public function setLogTable($log_table)

$log_table does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

The parameter $log_table is not named in camelCase.

    {
        $this->log_table = $log_table;

$log_table does not seem to conform to the naming convention (^[a-z][a-zA-Z0-9]*$).

    }
}

As per coding style, files should not end with a newline character.