Configuration.php

<?php

use Business\Estimator\UpgradeEstimator;

class Configuration
{
    public const DEMOSHOP_GITHUB_URL_TO_COMPARE_WITH = 'https://github.com/spryker-shop';
    public const SPRYKER_VENDORS = [
        'spryker',
        'spryker-shop',
        'spryker-feature',
        'spryker-eco',
        'spryker-sdk',
    ];
    public const VENDOR_SPRYKER_FEATURE = 'spryker-feature';
    public const GITHUB_CONTENT_URL = 'https://raw.githubusercontent.com';
    public const COMPOSER_JSON_FILE_NAME = 'composer.json';
    public const LAYERS = ['Client', 'Glue', 'Shared', 'Service', 'Zed', 'Yves'];
    public const OUTPUTS_FOLDER_PATH = './outputs';
    public const UPGRADE_GUIDES_FOLDER_PATH = './UpgradeGuides';

    protected const DEMOSHOP_TYPE_B2C = 'b2c-demo-shop';
    protected const DEMOSHOP_TYPE_B2B = 'b2b-demo-shop';
    protected const DEMOSHOP_TYPE_B2B_MARKETPLACE = 'b2b-demo-marketplace';
    protected const DEMOSHOP_TYPE_B2C_MARKETPLACE = 'b2c-demo-marketplace';

    protected const CONFIG_FILE_NAME = 'config.ini';
    protected const CONFIGURATION_KEY_PATH_TO_PROJECT = 'path_to_project';
    protected const CONFIGURATION_KEY_DESIRED_VERSON = 'desired_version';
    protected const CONFIGURATION_KEY_CURRENT_DEMOSHOP_TYPE = 'current_demoshop_type';
    protected const CONFIGURATION_KEY_PROJECT_MAIN_NAMESPACE_PATH = 'project_main_namespace_path';
    protected const CONFIGURATION_KEY_PROJECT_NAMESPACE_PATHES = 'project_namespace_pathes';
    protected const CONFIGURATION_KEY_PROJECT_GLOSSARY_PATH = 'project_glossary_path';
    protected const CONFIGURATION_KEY_UPDATED_PACKAGES = 'updated_packages';
    protected const CONFIGURATION_KEY_PARTIAL_UPDATE_PACKAGES = 'partial_update_packages';
    protected const CONFIGURATION_KEY_PARTIAL_UPDATE_PACKAGES_NOT_IN = 'partial_update_packages_not_in';
    protected const GITHUB_TOKEN = 'github_token';
    protected const CONFIGURATION_KEY_DESIRED_PHP_VERSON = 'desired_php_version';

    protected array $configuration;

    public function __construct()
    {
        $this->configuration = parse_ini_file(static::CONFIG_FILE_NAME);
    }

    public function getPathToProject(): string
    {
        return $this->configuration[static::CONFIGURATION_KEY_PATH_TO_PROJECT];
    }

    public function getDesiredVersion(): string
    {
        return $this->configuration[static::CONFIGURATION_KEY_DESIRED_VERSON];
    }

    public function getCurrentDemoshopType(): string
    {
        return $this->configuration[static::CONFIGURATION_KEY_CURRENT_DEMOSHOP_TYPE];
    }

    public function getProjectGlossaryPath(): string
    {
        return $this->configuration[static::CONFIGURATION_KEY_PROJECT_GLOSSARY_PATH];
    }

    public function getProjectMainNamespacePath(): string
    {
        return $this->configuration[static::CONFIGURATION_KEY_PROJECT_MAIN_NAMESPACE_PATH];
    }

    public function getProjectNamespacePathes(): array
    {
        return $this->configuration[static::CONFIGURATION_KEY_PROJECT_NAMESPACE_PATHES];
    }

    public function getUpdatedPackages(): array
    {
        return $this->configuration[static::CONFIGURATION_KEY_UPDATED_PACKAGES];
    }

    public function getPartialUpdatePackages(): array
    {
        return $this->configuration[static::CONFIGURATION_KEY_PARTIAL_UPDATE_PACKAGES] ?? [];
    }

    public function getPartialUpdatePackagesNotIn(): array
    {
        return $this->configuration[static::CONFIGURATION_KEY_PARTIAL_UPDATE_PACKAGES_NOT_IN] ?? [];
    }

    public function getAllDemoshopTypes(): array
    {
        return [
            static::DEMOSHOP_TYPE_B2C => static::DEMOSHOP_TYPE_B2C,
            static::DEMOSHOP_TYPE_B2B => static::DEMOSHOP_TYPE_B2B,
            static::DEMOSHOP_TYPE_B2C_MARKETPLACE => static::DEMOSHOP_TYPE_B2C_MARKETPLACE,
            static::DEMOSHOP_TYPE_B2B_MARKETPLACE => static::DEMOSHOP_TYPE_B2B_MARKETPLACE,
        ];
    }

    public function getGithubToken(): string
    {
        return $this->configuration[static::GITHUB_TOKEN];
    }

    public function getDesiredPHPVersion(): string
    {
        return $this->configuration[static::CONFIGURATION_KEY_DESIRED_PHP_VERSON];
    }

    public function getUpgradeEstimationReportFilePath(string $processType): string
    {
        if ($processType === UpgradeEstimator::PROCESS_TYPE_REGULAR_UPDATE) {
            return sprintf(
                '%s/upgrade_to_%s_estimation_report%s.csv',
                Configuration::OUTPUTS_FOLDER_PATH,
                $this->getDesiredVersion(),
                $this->isSdkInsideProject() ? '' : '_for_' . basename($this->getPathToProject()),
            );
        }

        if ($processType === UpgradeEstimator::PROCESS_TYPE_PHP_UPDATE) {
            return sprintf(
                '%s/upgrade_to_%s_estimation_report%s.csv',
                Configuration::OUTPUTS_FOLDER_PATH,
                'PHP_' . $this->getDesiredPHPVersion(),
                $this->isSdkInsideProject() ? '' : '_for_' . basename($this->getPathToProject()),
            );
        }

        return sprintf(
            '%s/partial_upgrade_estimation_report%s.csv',
            Configuration::OUTPUTS_FOLDER_PATH,
            $this->isSdkInsideProject() ? '' : '_for_' . basename($this->getPathToProject()),
        );
    }

    public function getCompatibilityReportFilePath(): string
    {
        return sprintf(
            '%s/PHP_compatybility_upgrade_instruction%s_to_%s.csv',
            static::OUTPUTS_FOLDER_PATH,
            $this->isSdkInsideProject() ? '' : '_for_' . basename($this->getPathToProject()),
            $this->getDesiredPHPVersion(),
        );
    }

    public function getPartialUpdateReportFilePath(): string
    {
        return sprintf(
            '%s/partial_upgrade_instruction%s.csv',
            static::OUTPUTS_FOLDER_PATH,
            $this->isSdkInsideProject() ? '' : '_for_' . basename($this->getPathToProject()),
        );
    }

    public function getUpdateOrderAnalyzerReportFilePath(): string
    {
        return sprintf(
            '%s/update_instruction%s_to_%s_version.csv',
            static::OUTPUTS_FOLDER_PATH,
            $this->isSdkInsideProject() ? '' : '_for_' . basename($this->getPathToProject()),
            $this->getDesiredVersion(),
        );
    }

    public function getGlossaryAnalyzerReportFilePath(): string
    {
        return sprintf(
            '%s/missing_glossary_keys%s.txt',
            static::OUTPUTS_FOLDER_PATH,
            $this->isSdkInsideProject() ? '' : '_for_' . basename($this->getPathToProject()),
        );
    }

    public function getOutdatedPackagesAnalyzerReportFilePath(): string
    {
        return sprintf(
            '%s/outdated_packages%s_comparing_to_%s_version.txt',
            static::OUTPUTS_FOLDER_PATH,
            $this->isSdkInsideProject() ? '' : '_in_' . basename($this->getPathToProject()),
            $this->getDesiredVersion(),
        );
    }

    public function getExtendedFilesAnalyzerReportFilePath(): string
    {
        return sprintf(
            '%s/%sextended_project_level_files_list.txt',
            static::OUTPUTS_FOLDER_PATH,
            $this->isSdkInsideProject() ? '' : basename($this->getPathToProject()) . '_',
        );
    }

    public function getMissingPluginsFinderReportFilePath(): string
    {
        return sprintf(
            '%s/missing_plugins%s_comparing_to_%s_version.txt',
            static::OUTPUTS_FOLDER_PATH,
            $this->isSdkInsideProject() ? '' : '_in_' . basename($this->getPathToProject()),
            $this->getDesiredVersion(),
        );
    }

    protected function isSdkInsideProject(): bool
    {
        return $this->getPathToProject() === '..';
    }
}