susina/psr2-code-generator

<?php declare(strict_types=1);

namespace Susina\Codegen\Config;

use gossi\docblock\Docblock;
use phootwork\lang\Comparator;
use Susina\Codegen\Generator\CodeGenerator;
use Symfony\Component\OptionsResolver\Options;
use Symfony\Component\OptionsResolver\OptionsResolver;

/**
 * Configuration for code generation.
 *
 * @author Thomas Gossmann
 * @author Cristiano Cinotti
 */
class GeneratorConfig
{
    /** @var array */
    protected $options;

    /**
     * Creates a new configuration for code generator.
     */
    public function __construct(?array $options = null)
    {
        $options = $options ?? [];
        $resolver = new OptionsResolver();
        $this->configureOptions($resolver);
        $this->options = $resolver->resolve($options);
    }

    /**
     * Returns whether empty docblocks are generated.
     *
     * @return bool `true` if they will be generated and `false` if not
     */
    public function getGenerateEmptyDocblock(): bool
    {
        return $this->options['generateEmptyDocblock'];
    }

    /**
     * Sets whether empty docblocks are generated.
     *
     * @param bool $generate `true` if they will be generated and `false` if not
     *
     * @return $this
     */
    public function setGenerateEmptyDocblock(bool $generate): self
    {
        $this->options['generateEmptyDocblock'] = $generate;

        return $this;
    }

    /**
     * Returns whether sorting is enabled.
     *
     * @return bool `true` if it is enabled and `false` if not
     */
    public function isSortingEnabled(): bool
    {
        return $this->options['enableSorting'];
    }

    /**
     * Whether to use the Php 7.4 typed properties declaration.
     */
    public function isPhp74Properties(): bool
    {
        return $this->options['php74Properties'];
    }

    /**
     * Returns the use statement sorting.
     *
     * @return bool|\Closure|Comparator|string
     */
    public function getUseStatementSorting()
    {
        return $this->options['useStatementSorting'];
    }

    /**
     * Returns the constant sorting.
     *
     * @return bool|\Closure|Comparator|string
     */
    public function getConstantSorting()
    {
        return $this->options['constantSorting'];
    }

    /**
     * Returns the property sorting.
     *
     * @return bool|\Closure|Comparator|string
     */
    public function getPropertySorting()
    {
        return $this->options['propertySorting'];
    }

    /**
     * Returns the method sorting.
     *
     * @return bool|\Closure|Comparator|string
     */
    public function getMethodSorting()
    {
        return $this->options['methodSorting'];
    }

    /**
     * Returns whether sorting is enabled.
     *
     * @param $enabled bool `true` if it is enabled and `false` if not
     *
     * @return $this
     */
    public function setSortingEnabled(bool $enabled): self
    {
        $this->options['enableSorting'] = $enabled;

        return $this;
    }

    /**
     * Returns the use statement sorting.
     *
     * @param bool|\Closure|Comparator|string $sorting
     *
     * @return $this
     */
    public function setUseStatementSorting($sorting): self
    {
        $this->options['useStatementSorting'] = $sorting;

        return $this;
    }

    /**
     * Returns the constant sorting.
     *
     * @param bool|\Closure|Comparator|string $sorting
     *
     * @return $this
     */
    public function setConstantSorting($sorting): self
    {
        $this->options['constantSorting'] = $sorting;

        return $this;
    }

    /**
     * Returns the property sorting.
     *
     * @param bool|\Closure|Comparator|string $sorting
     *
     * @return $this
     */
    public function setPropertySorting($sorting): self
    {
        $this->options['propertySorting'] = $sorting;

        return $this;
    }

    /**
     * Returns the method sorting.
     *
     * @param bool|\Closure|Comparator|string $sorting
     *
     * @return $this
     */
    public function setMethodSorting($sorting): self
    {
        $this->options['methodSorting'] = $sorting;

        return $this;
    }

    /**
     * Returns the file header comment.
     *
     * @return null|Docblock the header comment
     */
    public function getHeaderComment(): ?Docblock
    {
        return $this->options['headerComment'];
    }

    /**
     * Sets the file header comment.
     *
     * @param string $comment the header comment
     *
     * @return $this
     */
    public function setHeaderComment(string $comment): self
    {
        $this->options['headerComment'] = new Docblock($comment);

        return $this;
    }

    /**
     * Returns the file header docblock.
     *
     * @return Docblock the docblock
     */
    public function getHeaderDocblock(): ?Docblock
    {
        return $this->options['headerDocblock'];
    }

    /**
     * Sets the file header docblock.
     *
     * @param Docblock $docblock the docblock
     *
     * @return $this
     */
    public function setHeaderDocblock(Docblock $docblock): self
    {
        $this->options['headerDocblock'] = $docblock;

        return $this;
    }

    protected function configureOptions(OptionsResolver $resolver): void
    {
        $resolver->setDefaults([
            'generateEmptyDocblock' => false,
            'enableSorting' => true,
            'useStatementSorting' => CodeGenerator::SORT_USESTATEMENTS_DEFAULT,
            'constantSorting' => CodeGenerator::SORT_CONSTANTS_DEFAULT,
            'propertySorting' => CodeGenerator::SORT_PROPERTIES_DEFAULT,
            'methodSorting' => CodeGenerator::SORT_METHODS_DEFAULT,
            'headerComment' => null,
            'headerDocblock' => null,
            'php74Properties' => false,
        ]);

        $resolver->setAllowedTypes('generateEmptyDocblock', 'bool');
        $resolver->setAllowedTypes('enableSorting', 'bool');
        $resolver->setAllowedTypes('php74Properties', 'bool');
        $resolver->setAllowedTypes('useStatementSorting', ['bool', 'string', '\Closure', 'phootwork\lang\Comparator']);
        $resolver->setAllowedTypes('constantSorting', ['bool', 'string', '\Closure', 'phootwork\lang\Comparator']);
        $resolver->setAllowedTypes('propertySorting', ['bool', 'string', '\Closure', 'phootwork\lang\Comparator']);
        $resolver->setAllowedTypes('methodSorting', ['bool', 'string', '\Closure', 'phootwork\lang\Comparator']);
        $resolver->setAllowedTypes('headerComment', ['null', 'string', 'gossi\\docblock\\Docblock']);
        $resolver->setAllowedTypes('headerDocblock', ['null', 'string', 'gossi\\docblock\\Docblock']);

        $resolver->setNormalizer('headerComment', function (Options $options, ?string $value): ?Docblock {
            return $this->toDocblock($value);
        });
        $resolver->setNormalizer('headerDocblock', function (Options $options, ?string $value): ?Docblock {
            return $this->toDocblock($value);
        });
    }

    /**
     * @param mixed $value
     */
    private function toDocblock($value): ?Docblock
    {
        if (is_string($value)) {
            $value = Docblock::create()->setLongDescription($value);
        }

        return $value;
    }
}