AddonXml::getAllowedMethods() - Code Metrics - Inspection of "refactor; autocomplete;" - LFFATE/ccg - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — 4.9 ( 8f0f3a...f6adb4 )

by Mikhail
created 2019-05-05 18:06 UTC
AddonXml::getAllowedMethods() A

↳ Parent: AddonXml
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
eloc	1
dl	0
loc	3
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0
<?php

namespace controllers;

use generators\AddonXml\AddonXmlGenerator;
use generators\Language\LanguageGenerator;
use generators\Readme\ReadmeGenerator;
use generators\MultipleFileGenerator;
use generators\FileGenerator;
use terminal\Terminal;
use filesystem\Filesystem;
use mediators\GeneratorMediator;
use \Config;

class AddonXml extends AbstractController
{
    private $config;
    private $terminal;
    private $filesystem;
    private $mfGenerator;
    private static $allowedMethods = [
        'help',
        'create',
        'remove',
        'update'
    ];

    use HelpTrait;

    function __construct(
        Config              $config,
        Terminal            $terminal,
        Filesystem          $filesystem
    )
    {
        $this->config               = $config;
        $this->terminal             = $terminal;
        $this->filesystem           = $filesystem;

        $addonXmlGenerator      = new AddonXmlGenerator($this->config);
        $languageGenerator      = new LanguageGenerator($this->config);
        $generatorMediator      = new GeneratorMediator();

        $generatorMediator
            ->addGenerator($addonXmlGenerator)
            ->addGenerator($languageGenerator);

        $this->mfGenerator = new MultipleFileGenerator($this->filesystem);
        $this->mfGenerator
            ->addGenerator($addonXmlGenerator)
            ->addGenerator($languageGenerator);
    }

    /**
     * @inheritdoc
     */
    public static function getAllowedMethods(): array
    {
        return self::$allowedMethods;
    }

    /**
     * help:
     * addon-xml create
     * creates addonXml structure and write it to file
     * @throws Exception if file already exists
     */
    public function create()
    {
        $addonXmlFileGenerator = $this->mfGenerator
            ->find(AddonXmlGenerator::class);
        
        $addonXmlGenerator = $addonXmlFileGenerator
                ->throwIfExists('Such addon.xml already exists. Remove it first if you want to replace it.')
                ->extract();
                
        $addonXmlGenerator
            ->create();

        $addonXmlFileGenerator    
            ->write()
            ->throwIfNotExists($addonXmlGenerator->getPath() . ' cannot be created.');

        /**
         * results
         */
        $this->terminal->success($addonXmlGenerator->getPath() . ' was created');
        $this->terminal->diff(
            \Diff::toString(\Diff::compare('', $addonXmlGenerator->toString()))
        );
    }

    /**
     * help:
     * addon-xml remove
     * removes file addon.xml
     * @throws Exception if file doesn't exists
     */
    public function remove()
    {
        $addonXmlGenerator = $this->mfGenerator
            ->find(AddonXmlGenerator::class)
                ->read()
                ->remove()
                ->throwIfExists('File cannot be removed.')
                ->extract();

        $this->terminal->success($addonXmlGenerator->getPath() . ' was removed');
        $this->terminal->diff(
            \Diff::toString(\Diff::compare($addonXmlGenerator->toString(), ''))
        );
    }

    /**
     * help:
     * addon-xml update addon.id=<addon_id> <item> [remove] [...args]
     * Sets additional field to addon xml file
     * addon.id - id of the addon
     * ---
     *      settings-item (si) - <item id="date">...</item>
     *           args: section=<section_id> type=<type> id=<id> [dv=<default_value>] [v=<variants>]
     *              section         - id for the settings section
     *              type            - type of the item id: input, textarea, password, checkbox, selectbox, multiple select, multiple checkboxes, countries list, states list, file, info, header, template
     *              id              - id of the setting item
     *              default_value   - (df) - default value for setting item
     *              variants        - (v) - list of item value variants comma separated
     * ---
     * 
     * see more @link [https://www.cs-cart.ru/docs/4.9.x/developer_guide/addons/scheme/scheme3.0_structure.html]
     * @throws Exception if file doesn't exists
     */
    public function update()
    {
        $this->mfGenerator
            ->throwIfNotExists('Some addon file not found.')
            ->read();

        $old_content = [];
        $this->mfGenerator->each(function($generator) use (&$old_content) {
            $old_content[get_class($generator->extract())] = $generator->extract()->toString();
        });
        
        $addonXmlGenerator = $this->mfGenerator
            ->find(AddonXmlGenerator::class)
                ->extract();
                ->/** @scrutinizer ignore-call */ extract();

        switch (true)
        {
            case $this->config->get('settings-item'):
            case $this->config->get('si'):
                if (true === $this->config->get('remove')) {
                    $addonXmlGenerator->removeSetting(
                        $this->config->get('id')
                    );
                } else {
                    $addonXmlGenerator->setSetting(
                        $this->config->get('section'),
                        $this->config->get('type'),
                        $this->config->get('id'),
                        $this->config->getOr('default_value', 'dv') ?: '',
                        (function($config) {
                            $variants = $config->getOr('variants', 'v');

                            return $variants ? explode(',', $variants) : [];
                        })($this->config)
                    );
                }
            break;
            default:
                throw new \BadMethodCallException('There is no such command');
        }

        $this->mfGenerator
            ->write()
            ->throwIfNotExists();
        
        $this->mfGenerator->each(function($generator) use ($old_content) {
            $this->terminal->diff(
                \Diff::toString(\Diff::compare($old_content[get_class($generator->extract())], $generator->extract()->toString()))
            );
        });
    }
}

LFFATE / ccg

Push — 4.9 ( 8f0f3a...f6adb4 )

AddonXml::getAllowedMethods() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
