CalcLengthFactory::handleUnitLengthToken() - Code Metrics - Inspection of "Create viewport length" - jkphl/responsive-images-css - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 297d0e...a57d9e )

by Joschi
created 2018-04-03 17:48 UTC
CalcLengthFactory::handleUnitLengthToken() A

↳ Parent: CalcLengthFactory
Complexity

Conditions	2
Paths	2
Size

Total Lines	21
Code Lines	12
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	6
Importance

Changes
Metric	Value
cc	2
eloc	12
nc	2
nop	2
dl	0
loc	21
ccs	0
cts	13
cp	0
crap	6
rs	9.3142
c	0
b	0
f	0
<?php

/**
 * responsive-images-css
 *
 * @category   Jkphl
 * @package    Jkphl\Respimgcss
 * @subpackage Jkphl\Respimgcss\Application\Factory
 * @author     Joschi Kuphal <[email protected]> / @jkphl
 * @copyright  Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
 * @license    http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Jkphl\Respimgcss\Application\Factory;

use ChrisKonnertz\StringCalc\Parser\Nodes\ContainerNode;
use ChrisKonnertz\StringCalc\StringCalc;
use ChrisKonnertz\StringCalc\Tokenizer\Token;
use Jkphl\Respimgcss\Application\Contract\UnitLengthInterface;
use Jkphl\Respimgcss\Application\Exceptions\InvalidArgumentException;
use Jkphl\Respimgcss\Application\Model\AbsoluteLength;
use Jkphl\Respimgcss\Application\Model\ViewportFunction;
use Jkphl\Respimgcss\Application\Model\ViewportLength;
use Jkphl\Respimgcss\Application\Service\LengthNormalizerService;

/**
 * Length factory for calc() based values
 *
 * @package    Jkphl\Respimgcss
 * @subpackage Jkphl\Respimgcss\Application\Factory
 */
class CalcLengthFactory
{
    /**
     * Create a unit length from a calc() size string
     *
     * @param string $calcString calc() size string
     * @param int $emPixel       EM to pixel ratio
     *
     * @return UnitLengthInterface
     * @throws \ChrisKonnertz\StringCalc\Exceptions\ContainerException
     * @throws \ChrisKonnertz\StringCalc\Exceptions\InvalidIdentifierException
     * @throws \ChrisKonnertz\StringCalc\Exceptions\NotFoundException
     */
    public static function createFromString(string $calcString, int $emPixel = 16): UnitLengthInterface
    {
        // If the calc() string is ill-formatted
        if (!preg_match('/^calc\(.+\)$/', $calcString)) {
            throw new InvalidArgumentException(
                sprintf(InvalidArgumentException::ILL_FORMATTED_CALC_LENGTH_STRING_STR, $calcString),
                InvalidArgumentException::ILL_FORMATTED_CALC_LENGTH_STRING
            );
        }

        return self::createCalculationContainerFromString($calcString, $emPixel);
    }

    /**
     * Parse a calculation string and return a precompiled calculation node container
     *
     * @param string $calcString Calculation string
     * @param int $emPixel       EM to pixel ratio
     *
     * @return ContainerNode Calculation node container
     * @throws \ChrisKonnertz\StringCalc\Exceptions\ContainerException
     * @throws \ChrisKonnertz\StringCalc\Exceptions\InvalidIdentifierException
     * @throws \ChrisKonnertz\StringCalc\Exceptions\NotFoundException
     */
    protected static function createCalculationContainerFromString(
        string $calcString,
        int $emPixel = 16
    ): UnitLengthInterface {
        $stringCalc    = new StringCalc();
        $calcTokens    = $stringCalc->tokenize($calcString);
        $refinedTokens = self::refineCalculationTokens($calcTokens, $emPixel);

        // If there's the viewport involved in the calculation: Create a relative calculated length
        /** @var Token $token */
        foreach ($refinedTokens as $token) {
            if (($token->getType() == Token::TYPE_WORD) && ($token->getValue() === 'viewport')) {
                return self::createViewportUnitFromTokens($refinedTokens, $stringCalc, $emPixel);

            }
        }

        // Create and return an absolute length
        return new AbsoluteLength(

            $stringCalc->calculate($refinedTokens),
            $stringCalc->calculate(/** @scrutinizer ignore-type */ $refinedTokens),
            UnitLengthInterface::UNIT_PIXEL,
            new LengthNormalizerService($emPixel)
        );
    }

    /**
     * Create a unit length from calculation tokens
     *
     * @param Token[] $tokens        Calculation tokens
     * @param StringCalc $stringCalc StringCalc instance
     * @param int $emPixel           EM to pixel ratio
     *
     * @return UnitLengthInterface Unit length
     * @throws \ChrisKonnertz\StringCalc\Exceptions\ContainerException
     * @throws \ChrisKonnertz\StringCalc\Exceptions\InvalidIdentifierException
     * @throws \ChrisKonnertz\StringCalc\Exceptions\NotFoundException
     */
    protected static function createViewportUnitFromTokens(
        array $tokens,
        StringCalc $stringCalc,
        int $emPixel = 16
    ): UnitLengthInterface {
        $stringHelper = $stringCalc->getContainer()->get('stringcalc_stringhelper');
        $stringCalc->getSymbolContainer()->add(new ViewportFunction($stringHelper));

        return new ViewportLength($stringCalc->parse($tokens), new LengthNormalizerService($emPixel));
    }

    /**
     * Refine a list of symbol tokens
     *
     * @param Token[] $tokens Symbol tokens
     * @param int $emPixel    EM to pixel ratio
     *
     * @return Token[] Refined symbol tokens
     */
    protected static function refineCalculationTokens(array $tokens, int $emPixel = 16): array
    {
        $refinedTokens = [];
        $previousToken = null;

        // Run through all tokens
        foreach ($tokens as $token) {
            $previousToken = self::handleToken($refinedTokens, $token, $previousToken, $emPixel);
        }

        // Add the last token
        if ($previousToken) {
            array_push($refinedTokens, $previousToken);
        }

        return $refinedTokens;
    }

    /**
     * Handle a particular token
     *
     * @param Token[] $refinedTokens    Refined tokens
     * @param Token $token              Token
     * @param Token|null $previousToken Previous token
     * @param int $emPixel              EM to pixel ratio
     *
     * @return Token|null               Stash token
     */
    protected static function handleToken(
        array &$refinedTokens,
        Token $token,
        Token $previousToken = null,
        int $emPixel = 16
    ): ?Token {
        // If it's a word token: Handle individually
        if ($token->getType() == Token::TYPE_WORD) {
            return self::handleWordToken($refinedTokens, $token, $previousToken, $emPixel);
        }

        // In all other cases: Register the previou token (if any)
        if ($previousToken) {
            array_push($refinedTokens, $previousToken);
        }

        // If it's a number token: Stash
        if ($token->getType() == Token::TYPE_NUMBER) {
            return $token;
        }

        array_push($refinedTokens, $token);

        return null;
    }

    /**
     * Handle a particular token
     *
     * The method returns a list of zero or more (possibly refined) tokens to preerve
     *
     * @param Token[] $refinedTokens    Refined tokens
     * @param Token $token              Token
     * @param Token|null $previousToken Previous token
     * @param int $emPixel              EM to pixel ratio
     *
     * @return Token|null               Stash token
     * @throws InvalidArgumentException If the word token is invalid
     */
    protected static function handleWordToken(
        array &$refinedTokens,
        Token $token,
        Token $previousToken = null,
        int $emPixel = 16
    ): ?Token {
        // If it's a calc() function call: Add the previous token and skip the current one
        if ($token->getValue() == 'calc') {
            if ($previousToken) {
                array_push($refinedTokens, $previousToken);
            }

            return null;
        }

        // If the previous token is a number: Try to generate a unit length
        if ($previousToken && ($previousToken->getType() == Token::TYPE_NUMBER)) {
            try {
                $unitLength = LengthFactory::createLengthFromString(
                    $previousToken->getValue().$token->getValue(),
                    $emPixel
                );
                self::handleUnitLengthToken($refinedTokens, $unitLength);

                return null;
            } catch (InvalidArgumentException $e) {
                // Ignore
            }
        }

        // Invalid word token
        throw new InvalidArgumentException(
            sprintf(InvalidArgumentException::INVALID_WORD_TOKEN_IN_SOURCE_SIZE_VALUE_STR, $token->getValue()),
            InvalidArgumentException::INVALID_WORD_TOKEN_IN_SOURCE_SIZE_VALUE
        );
    }

    /**
     * Handle a unit length token
     *
     * @param Token[] $refinedTokens          Refined tokens
     * @param UnitLengthInterface $unitLength Unit length
     */
    protected static function handleUnitLengthToken(
        array &$refinedTokens,
        UnitLengthInterface $unitLength
    ): void {
        // If it's an absolute value
        if ($unitLength->isAbsolute()) {
            array_push($refinedTokens, new Token(strval($unitLength->getValue()), Token::TYPE_NUMBER, 0));

            return;
        }

        // Else: Substitute with multiplied function expression
        array_push(
            $refinedTokens,
            new Token('(', Token::TYPE_CHARACTER, 0),
            new Token(strval($unitLength->getValue() / 100), Token::TYPE_NUMBER, 0),
            new Token('*', Token::TYPE_CHARACTER, 0),
            new Token('viewport', Token::TYPE_WORD, 0),
            new Token('(', Token::TYPE_CHARACTER, 0),
            new Token(')', Token::TYPE_CHARACTER, 0),
            new Token(')', Token::TYPE_CHARACTER, 0)
        );
    }
}
jkphl / responsive-images-css

Push — master ( 297d0e...a57d9e )

CalcLengthFactory::handleUnitLengthToken() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
