Alister\ReservedNamesBundle\Services\ReservedNames

Complexity

Total Complexity

11

Size/Duplication

Total Lines	95
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	inReservedList()	0	3	1
A	isReservedPlural()	0	6	1
A	__construct()	0	6	2
A	isReserved()	0	17	4
A	getReservedNames()	0	3	1
A	isTest()	0	13	2

<?php
namespace Alister\ReservedNamesBundle\Services;

class ReservedNames implements ReservedNamesInterface
{
    /** @var array of usernames to check against */
    private $reservedNames;

    /** @var CleanUserNamesInterface class to return a 'clean' username */
    private $cleanUsername;

    public function __construct(array $reservedNames, CleanUserNamesInterface $cleanUsername)
    {
        if (empty($this->reservedNames)) {
            $this->reservedNames = $reservedNames;
        }
        $this->cleanUsername = $cleanUsername;
    }

    /**
     * Allow the reserved username list to be extracted.
     *
     * The inbuild list is written all in lower-case, but any new ones are
     * down-cased as part of the bundle configuration.
     *
     * @return array list of usernames ['username' => 1, ...]
     */
    public function getReservedNames()
    {
        return $this->reservedNames;
    }

    /**
     * A ReservedName is one based on a list - we also strip numbers and '-_' chars.
     *
     * @param string $username [description]
     *
     * @return bool Is the username reserved?
     */
    public function isReserved($username)
    {
        if (array_key_exists($username, $this->reservedNames)) {
            return true;
        }

        $cleanName = $this->cleanUsername->clean($username);
        if ($this->isTest($cleanName, true)) {
            return true;
        }

        if ($this->inReservedList($cleanName)) {
            return true;
        }

        // we've gotten here, so far, so good. One final test - trim 's's
        return $this->isReservedPlural($cleanName);
    }

    public function inReservedList($username)
    {
        return array_key_exists($username, $this->reservedNames);
    }

    /**
     * For our point of view, we are looking for anything with an 's'.
     *
     * @param string $username [description]
     *
     * @return bool Does it have an 's' at the end (with any 'noise chars' before it)
     */
    public function isReservedPlural($username)
    {
        // finally, remove any trailing 's', or the usual other chars
        $cleanerName = rtrim($username, 's0123456789-_ ');

        return $this->inReservedList($cleanerName);
    }

    /**
     * Convenience function - is the post-cleaned username start with 'test' ?
     *
     * @param string username to clean and check

The type Alister\ReservedNamesBundle\Services\username was not found. Maybe you did not declare it correctly or list all dependencies?

     *
     * @return bool true if the first 4 'real' chars are 'test'
     */
    public function isTest($username, $isClean = false)
    {
        if (!$isClean) {
            $username = $this->cleanUsername->clean($username);
        }

        /*
         * This direct-check-return is good for code complexity,
         * but doesn't obviously check the true and false cases.
         * With an explicit return true/false, we would prove that
         * both possibilities were covered.
         */
        return 0 === strpos($username, 'test');
    }
}