ApacheVelocity::getSyntaxName() - Code Metrics - Inspection of "introducing showprice command" - Mistralys/mailcode - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#18)

unknown
created 2024-08-26 13:42 UTC
ApacheVelocity::getSyntaxName() A

↳ Parent: ApacheVelocity
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	3
rs	10
cc	1
nc	1
nop	0
<?php
/**
 * File containing the {@see \Mailcode\Translator\Syntax\ApacheVelocity} class.
 *
 * @package Mailcode
 * @subpackage Translator
 * @see \Mailcode\Translator\Syntax\ApacheVelocity
 */

declare(strict_types=1);

namespace Mailcode\Translator\Syntax;

use Mailcode\Interfaces\Commands\EncodableInterface;
use Mailcode\Mailcode_Commands_Command;
use Mailcode\Mailcode_Commands_Keywords;
use Mailcode\Mailcode_Number_Info;
use Mailcode\Mailcode_Number_LocalCurrency;
use Mailcode\Translator\BaseCommandTranslation;
use function Mailcode\dollarize;

/**
 * Abstract base class for apache velocity command translation classes.
 *
 * @package Mailcode
 * @subpackage Translator
 * @author Sebastian Mordziol <[email protected]>
 */
abstract class ApacheVelocity extends BaseCommandTranslation
{
    /**
     * @var string[]
     */
    private array $regexSpecialChars = array(
        '?',
        '.',
        '[',
        ']',
        '|',
        '{',
        '}',
        '$',
        '*',
        '^',
        '+',
        '<',
        '>',
        '(',
        ')'
    );

    public function getLabel(): string
    {
        return 'Apache Velocity';
    }

    /**
     * Filters the string for use in an Apache Velocity (Java)
     * regex string: escapes all special characters.
     *
     * Velocity does its own escaping, so no need to escape special
     * characters as if they were a javascript string.
     *
     * @param string $string
     * @return string
     */
    public function filterRegexString(string $string): string
    {
        // Special case: previously escaped quotes.
        // To avoid modifying them, we strip them out.
        $string = str_replace('\\"', 'ESCQUOTE', $string);

        // Any other existing backslashes in the string
        // have to be double-escaped, giving four
        // backslashes in the java regex.
        $string = str_replace('\\', '\\\\', $string);

        // All other special characters have to be escaped
        // with two backslashes.
        foreach ($this->regexSpecialChars as $char) {
            $string = str_replace($char, '\\' . $char, $string);
        }

        // Restore the escaped quotes, which stay escaped
        // with a single backslash.
        $string = str_replace('ESCQUOTE', '\\"', $string);

        return $string;
    }

    protected function renderVariableEncodings(Mailcode_Commands_Command $command, string $varName): string
    {
        if (!$command instanceof EncodableInterface || !$command->hasActiveEncodings()) {
            return sprintf(
                '${%s}',
                $varName
            );
        }

        return $this->renderEncodings($command, dollarize($varName));
    }

    public function renderNumberFormat(string $varName, Mailcode_Number_Info $numberInfo, bool $absolute): string
    {
        $varName = dollarize($varName);

        if ($absolute) {
            $varName = sprintf('${numeric.abs(%s)}', $varName);
        }

        return sprintf(
            "numeric.format(%s, %s, '%s', '%s')",
            $varName,
            $numberInfo->getDecimals(),
            $numberInfo->getDecimalsSeparator(),
            $numberInfo->getThousandsSeparator()
        );
    }

    public function renderStringToNumber(string $varName): string
    {
        return sprintf(
            '$numeric.toNumber(%s)',
            dollarize($varName)
        );
    }

    public function renderPrice(string $varName, Mailcode_Number_LocalCurrency $localCurrency, bool $absolute = false, bool $withCurrencyName = true): string
    {
        $varName = dollarize($varName);

        if ($absolute) {
            $varName = sprintf('${numeric.abs(%s)}', $varName);
        }

        $numberInfo = $localCurrency->getFormatInfo();

        $displayedCurrency = $withCurrencyName
            ? $localCurrency->getCurrencyName()
            : $localCurrency->getCurrencySymbol();

        return sprintf(
            "money.amount(%s, '%s').group('%s').unit('%s', '%s').separator('%s')",
            $varName,
            $numberInfo->getDecimalsSeparator(),
            $numberInfo->getThousandsSeparator(),
            $displayedCurrency,
            $localCurrency->getCountry(),
            $localCurrency->getUnitSeparator()
        );
    }

    public function renderQuotedValue(string $value): string
    {
        return sprintf(
            '"%s"',
            str_replace('"', '\"', $value)
        );
    }

    public function getSyntaxName(): string
    {
        return 'ApacheVelocity';
    }

    /**
     * @var array<string,string>
     */
    private array $encodingTemplates = array(
        Mailcode_Commands_Keywords::TYPE_URLENCODE => '${esc.url(%s)}',
        Mailcode_Commands_Keywords::TYPE_URLDECODE => '${esc.unurl(%s)}',
        Mailcode_Commands_Keywords::TYPE_IDN_ENCODE => '${text.idn(%s)}',
        Mailcode_Commands_Keywords::TYPE_IDN_DECODE => '${text.unidn(%s)}'
    );

    protected function renderEncodings(EncodableInterface $command, string $statement): string
    {
        $encodings = $command->getActiveEncodings();
        $result = $statement;

        foreach ($encodings as $encoding) {
            $result = $this->renderEncoding($encoding, $result, $command);
        }

        return $result;
    }

    protected function renderEncoding(string $keyword, string $result, EncodableInterface $command): string
    protected function renderEncoding(string $keyword, string $result, /** @scrutinizer ignore-unused */ EncodableInterface $command): string
    {
        $template = $this->encodingTemplates[$keyword] ?? '%s';

        return sprintf($template, $result);
    }
}

Mistralys / mailcode

Pull Request — master (#18)

ApacheVelocity::getSyntaxName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
