Generator::buildCharacterPool() - Code Metrics - Inspection of "refactor: break down Generator::generate() into sm..." - stymiee/password-helper - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 1d5b30...945cac )

by John
created 2025-06-05 13:54 UTC
Generator::buildCharacterPool() A

↳ Parent: Generator
Complexity

Conditions	5
Paths	16
Size

Total Lines	25
Code Lines	10
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	5
eloc	10
nc	16
nop	4
dl	0
loc	25
rs	9.6111
c	0
b	0
f	0
<?php

declare(strict_types=1);

namespace PasswordHelper;

use Exception;
use InvalidArgumentException;

/**
 * Generates secure random passwords based on specified requirements.
 *
 * This class provides methods to generate passwords with various character types
 * and ensures they meet minimum security requirements.
 *
 * @package PasswordHelper
 */
class Generator
{
    /**
     * Default minimum length for generated passwords.
     */
    private const DEFAULT_MIN_LENGTH = 12;

    /**
     * Default maximum length for generated passwords.
     */
    private const DEFAULT_MAX_LENGTH = 20;

    /**
     * Creates a new password generator.
     */
    public function __construct(
        private int $minLength = self::DEFAULT_MIN_LENGTH,
        private int $maxLength = self::DEFAULT_MAX_LENGTH
    ) {
        if ($this->minLength < 8) {
            throw new InvalidArgumentException('Minimum length must be at least 8 characters');
        }

        if ($this->maxLength < $this->minLength) {
            throw new InvalidArgumentException('Maximum length must be greater than minimum length');
        }
    }

    /**
     * Gets the minimum length for generated passwords.
     *
     * @return int The minimum length
     */
    public function getMinLength(): int
    {
        return $this->minLength;
    }

    /**
     * Gets the maximum length for generated passwords.
     *
     * @return int The maximum length
     */
    public function getMaxLength(): int
    {
        return $this->maxLength;
    }

    /**
     * Generates a random password that meets the specified requirements.
     *
     * @param bool $includeUppercase Whether to include uppercase letters
     * @param bool $includeLowercase Whether to include lowercase letters
     * @param bool $includeNumbers Whether to include numbers
     * @param bool $includeSpecial Whether to include special characters
     * @return string The generated password
     * @throws InvalidArgumentException If no character types are selected
     * @throws Exception
     */
    public function generate(
        bool $includeUppercase = true,
        bool $includeLowercase = true,
        bool $includeNumbers = true,
        bool $includeSpecial = true
    ): string {
        $this->validateCharacterTypes($includeUppercase, $includeLowercase, $includeNumbers, $includeSpecial);

        $chars = $this->buildCharacterPool($includeUppercase, $includeLowercase, $includeNumbers, $includeSpecial);
        $length = random_int($this->minLength, $this->maxLength);
        
        $password = $this->generateRequiredCharacters(
            $includeUppercase,
            $includeLowercase,
            $includeNumbers,
            $includeSpecial
        );

        $password = $this->fillRemainingCharacters($password, $chars, $length);
        
        return str_shuffle($password);
    }

    /**
     * Validates that at least one character type is selected.
     *
     * @param bool $includeUppercase Whether to include uppercase letters
     * @param bool $includeLowercase Whether to include lowercase letters
     * @param bool $includeNumbers Whether to include numbers
     * @param bool $includeSpecial Whether to include special characters
     * @throws InvalidArgumentException If no character types are selected
     */
    private function validateCharacterTypes(
        bool $includeUppercase,
        bool $includeLowercase,
        bool $includeNumbers,
        bool $includeSpecial
    ): void {
        if (!$includeUppercase && !$includeLowercase && !$includeNumbers && !$includeSpecial) {
            throw new InvalidArgumentException('At least one character type must be selected');
        }
    }

    /**
     * Builds the character pool based on selected character types.
     *
     * @param bool $includeUppercase Whether to include uppercase letters
     * @param bool $includeLowercase Whether to include lowercase letters
     * @param bool $includeNumbers Whether to include numbers
     * @param bool $includeSpecial Whether to include special characters
     * @return array<int, string> The character pool
     */
    private function buildCharacterPool(
        bool $includeUppercase,
        bool $includeLowercase,
        bool $includeNumbers,
        bool $includeSpecial
    ): array {
        $chars = [];

        if ($includeUppercase) {
            $chars = array_merge($chars, range('A', 'Z'));
        }

        if ($includeLowercase) {
            $chars = array_merge($chars, range('a', 'z'));
        }

        if ($includeNumbers) {
            $chars = array_merge($chars, array_map('strval', range(0, 9)));
        }

        if ($includeSpecial) {
            $chars = array_merge($chars, str_split('!@#$%^&*()_+-=[]{}|;:,.<>?'));
            $chars = array_merge($chars, /** @scrutinizer ignore-type */ str_split('!@#$%^&*()_+-=[]{}|;:,.<>?'));
        }

        return $chars;
    }

    /**
     * Generates the required characters for each selected character type.
     *
     * @param bool $includeUppercase Whether to include uppercase letters
     * @param bool $includeLowercase Whether to include lowercase letters
     * @param bool $includeNumbers Whether to include numbers
     * @param bool $includeSpecial Whether to include special characters
     * @return string The initial password with required characters
     * @throws Exception
     */
    private function generateRequiredCharacters(
        bool $includeUppercase,
        bool $includeLowercase,
        bool $includeNumbers,
        bool $includeSpecial
    ): string {
        $password = '';

        if ($includeUppercase) {
            $password .= $this->getRandomCharacter(range('A', 'Z'));
        }

        if ($includeLowercase) {
            $password .= $this->getRandomCharacter(range('a', 'z'));
        }

        if ($includeNumbers) {
            $password .= $this->getRandomCharacter(array_map('strval', range(0, 9)));
        }

        if ($includeSpecial) {
            $password .= $this->getRandomCharacter(str_split('!@#$%^&*()_+-=[]{}|;:,.<>?'));
            $password .= $this->getRandomCharacter(/** @scrutinizer ignore-type */ str_split('!@#$%^&*()_+-=[]{}|;:,.<>?'));
        }

        return $password;
    }

    /**
     * Fills the remaining characters in the password.
     *
     * @param string $password The current password
     * @param array<int, string> $chars The character pool
     * @param int $length The desired password length
     * @return string The completed password
     * @throws Exception
     */
    private function fillRemainingCharacters(string $password, array $chars, int $length): string
    {
        while (strlen($password) < $length) {
            $password .= $this->getRandomCharacter($chars);
        }

        return $password;
    }

    /**
     * Gets a random character from the given array.
     *
     * @param array<int, string> $chars Array of characters to choose from
     * @return string A random character
     * @throws Exception
     */
    private function getRandomCharacter(array $chars): string
    {
        return (string) $chars[random_int(0, count($chars) - 1)];
    }
}

stymiee / password-helper

Push — master ( 1d5b30...945cac )

Generator::buildCharacterPool() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
