Configuration::getAccessRolesDefinition() - Code Metrics - Inspection of "Added logging, added possibility to configure acce..." - RunOpenCode/exchange-rate-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 7d1fce...9e821b )

by Nikola
created 2016-12-12 18:34 UTC
Configuration::getAccessRolesDefinition() B

↳ Parent: Configuration
Complexity

Conditions	1
Paths	1
Size

Total Lines	30
Code Lines	25
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	27
CRAP Score	1
Importance

Changes
Metric	Value
dl	0
loc	30
ccs	27
cts	27
cp	1
rs	8.8571
c	0
b	0
f	0
cc	1
eloc	25
nc	1
nop	0
crap	1
<?php
/*
 * This file is part of the Exchange Rate Bundle, an RunOpenCode project.
 *
 * (c) 2016 RunOpenCode
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace RunOpenCode\Bundle\ExchangeRate\DependencyInjection;

use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;

/**
 * Class Configuration
 *
 * Configuration tree.
 *
 * @package RunOpenCode\Bundle\ExchangeRate\DependencyInjection
 */
class Configuration implements ConfigurationInterface
{
    /**
     * {@inheritdoc}
     */
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder();

        $rootNode = $treeBuilder->root('run_open_code_exchange_rate');

        $rootNode
            ->children()
                ->scalarNode('base_currency')
                    ->isRequired()
                    ->info('Set base currency in which you are doing your business activities.')
                ->end()
                ->scalarNode('repository')
                    ->defaultValue('file')
                    ->info('Service ID which is in charge for rates persistence.')
                ->end()
                ->append($this->getRatesDefinition())
                ->append($this->getFileRepositoryDefinition())
                ->append($this->getSourcesDefinition())
                ->append($this->getViewDefinition())
                ->append($this->getAccessRolesDefinition())
                ->append($this->getNotificationDefinition())
                ->arrayNode('form_types')
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->append($this->getSourceTypeDefinition())
                        ->append($this->getRateTypeTypeDefinition())
                        ->append($this->getCurrencyCodeTypeDefinition())
                        ->append($this->getRateTypeDefinition())
                    ->end()
                ->end()
            ->end()
        ->end();

        return $treeBuilder;
    }

    /**
     * Build configuration tree for rates.
     *
     * @return ArrayNodeDefinition
     */
    protected function getRatesDefinition()
    {
        $node = new ArrayNodeDefinition('rates');
        $node
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->info('Configuration of each individual rate with which you intend to work with.')
            ->requiresAtLeastOneElement()
                ->prototype('array')
                    ->children()
                        ->scalarNode('currency_code')->isRequired()->end()
                        ->scalarNode('rate_type')->isRequired()->end()
                        ->scalarNode('source')->isRequired()->end()
                        ->arrayNode('extra')->end()
                    ->end()
                ->end()
            ->end();

        return $node;
    }

    /**
     * Build configuration tree for repository.
     *
     * @return ArrayNodeDefinition
     */
    protected function getFileRepositoryDefinition()
    {
        $node = new ArrayNodeDefinition('file_repository');

        $node
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->info('Configuration for file repository (if used).')
            ->addDefaultsIfNotSet()
            ->children()
                ->scalarNode('path')
                ->info('Absolute path to file where database file will be stored.')
                ->defaultValue('%kernel.root_dir%/db/exchange_rates.dat')
                ->end()
            ->end()
        ->end();

        return $node;
    }

    /**
     * Build configuration tree for simple sources.
     *
     * @return ArrayNodeDefinition
     */
    protected function getSourcesDefinition()
    {
        $node = new ArrayNodeDefinition('sources');

        $node

            ->info('Add sources to sources registry without registering them into service container.')
            ->useAttributeAsKey('name')
            ->prototype('scalar')->end()
        ->end();

        return $node;
    }

    /**
     * Build configuration tree for view (controller).
     *
     * @return ArrayNodeDefinition
     */
    protected function getViewDefinition()
    {
        $node = new ArrayNodeDefinition('view');

        $node
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->info('Configuration of administration interface.')
            ->addDefaultsIfNotSet()
            ->children()
                ->scalarNode('base_template')
                    ->info('Base decorator template.')
                    ->defaultValue('@ExchangeRate/admin/base.html.twig')
                ->end()
                ->scalarNode('list')
                    ->info('Template for list view.')
                    ->defaultValue('@ExchangeRate/admin/list.html.twig')
                ->end()
                ->scalarNode('new')
                    ->info('Template for create new exchange rate view.')
                    ->defaultValue('@ExchangeRate/admin/new.html.twig')
                ->end()
                ->scalarNode('edit')
                    ->info('Template for edit exchange rate view.')
                    ->defaultValue('@ExchangeRate/admin/edit.html.twig')
                ->end()
                ->scalarNode('date_format')
                    ->info('Date format in list view.')
                    ->defaultValue('Y-m-d')
                ->end()
                ->scalarNode('time_format')
                    ->info('Date/time format in list view.')
                    ->defaultValue('H:i')
                ->end()
                ->booleanNode('secure')->defaultValue(true)->end()
            ->end()
        ->end();

        return $node;
    }

    /**
     * Build configuration tree for access roles.
     *
     * @return ArrayNodeDefinition
     */
    protected function getAccessRolesDefinition()
    {
        $node = new ArrayNodeDefinition('access_roles');

        $node
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->info('Configuration of controller access roles.')
            ->addDefaultsIfNotSet()
            ->children()
                ->arrayNode('list')
                    ->defaultValue(array('ROLE_EXCHANGE_RATE_MANAGER', 'ROLE_EXCHANGE_RATE_LIST'))
                    ->prototype('scalar')->end()
                ->end()
                ->arrayNode('create')
                    ->defaultValue(array('ROLE_EXCHANGE_RATE_MANAGER', 'ROLE_EXCHANGE_RATE_CREATE'))
                    ->prototype('scalar')->end()
                ->end()
                ->arrayNode('edit')
                    ->defaultValue(array('ROLE_EXCHANGE_RATE_MANAGER', 'ROLE_EXCHANGE_RATE_EDIT'))
                    ->prototype('scalar')->end()
                ->end()
                ->arrayNode('delete')
                    ->defaultValue(array('ROLE_EXCHANGE_RATE_MANAGER', 'ROLE_EXCHANGE_RATE_DELETE'))
                    ->prototype('scalar')->end()
                ->end()
            ->end()
        ->end();


        return $node;
    }

    /**
     * Build configuration tree for e-mail notifications.
     *
     * @return ArrayNodeDefinition
     */
    protected function getNotificationDefinition()
    {
        $node = new ArrayNodeDefinition('notifications');

        $node
            ->info('Notification settings.')
            ->addDefaultsIfNotSet()
            ->children()
                ->arrayNode('fetch')
                    ->children()
                        ->booleanNode('enabled')
                            ->info('Send e-mail report about fetch result and fetched rates.')
                            ->defaultTrue()
                        ->end()
                        ->scalarNode('from')
                            ->info('Mail sender address.')
                            ->defaultNull()
                        ->end()
                        ->arrayNode('to')
                            ->info('Recipients e-mail addresses.')
                            ->prototype('scalar')->end()
                        ->end()
                        ->arrayNode('cc')
                            ->info('Recipients e-mail addresses.')
                            ->prototype('scalar')->end()
                        ->end()
                        ->arrayNode('bcc')
                            ->info('Blank carbon copy recipients e-mail addresses.')
                            ->prototype('scalar')->end()
                        ->end()
                        ->arrayNode('templates')
                            ->addDefaultsIfNotSet()
                            ->info('Enable/disable individual mail notifications.')
                            ->children()
                                ->arrayNode('success')
                                    ->addDefaultsIfNotSet()
                                    ->children()
                                        ->booleanNode('enabled')
                                            ->info('Enable/disable success notification.')
                                            ->defaultTrue()
                                        ->end()
                                        ->scalarNode('subject')
                                            ->info('Mail notification subject.')
                                            ->defaultValue('System notification: exchange rates successfully fetched.')
                                        ->end()
                                        ->scalarNode('template')
                                            ->info('Mail body template.')
                                            ->defaultValue('@ExchangeRate/mail/success.html.twig')
                                        ->end()
                                    ->end()
                                ->end()
                                ->arrayNode('error')
                                    ->addDefaultsIfNotSet()
                                    ->children()
                                        ->booleanNode('enabled')
                                            ->info('Enable/disable success notification.')
                                            ->defaultTrue()
                                        ->end()
                                        ->scalarNode('subject')
                                            ->info('Mail notification subject.')
                                            ->defaultValue('Error notification: exchange rates are not fetched.')
                                        ->end()
                                        ->scalarNode('template')
                                            ->info('Mail body template.')
                                            ->defaultValue('@ExchangeRate/mail/error.html.twig')
                                        ->end()
                                    ->end()
                                ->end()
                            ->end()
                        ->end()
                    ->end()
                ->end()
            ->end()
        ->end();

        return $node;
    }

    /**
     * Build configuration tree for "RunOpenCode\Bundle\ExchangeRate\Form\Type\SourceType" default settings.
     *
     * @return ArrayNodeDefinition
     */
    protected function getSourceTypeDefinition()

    {
        $node = new ArrayNodeDefinition('source_type');

        $node
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->info('Modify default "RunOpenCode\\Bundle\\ExchangeRate\\Form\\Type\\SourceType" settings.')
            ->addDefaultsIfNotSet()
            ->children()
                ->scalarNode('choice_translation_domain')->defaultValue('roc_exchange_rate')->end()
                ->arrayNode('preferred_choices')->end()
            ->end()
        ->end();

        return $node;
    }

    /**
     * Build configuration tree for "RunOpenCode\Bundle\ExchangeRate\Form\Type\RateTypeType" default settings.
     *
     * @return ArrayNodeDefinition
     */
    protected function getRateTypeTypeDefinition()

    {
        $node = new ArrayNodeDefinition('rate_type_type');

        $node
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->info('Modify default "RunOpenCode\\Bundle\\ExchangeRate\\Form\\Type\\RateTypeType" settings.')
            ->addDefaultsIfNotSet()
            ->children()
                ->scalarNode('choice_translation_domain')->defaultValue('roc_exchange_rate')->end()
                ->arrayNode('preferred_choices')->end()
            ->end()
        ->end();

        return $node;
    }

    /**
     * Build configuration tree for "RunOpenCode\Bundle\ExchangeRate\Form\Type\CurrencyCodeType" default settings.
     *
     * @return ArrayNodeDefinition
     */
    protected function getCurrencyCodeTypeDefinition()

    {
        $node = new ArrayNodeDefinition('currency_code_type');

        $node
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->info('Modify default "RunOpenCode\\Bundle\\ExchangeRate\\Form\\Type\\CurrencyCodeType" settings.')
            ->addDefaultsIfNotSet()
            ->children()
                ->scalarNode('choice_translation_domain')->defaultValue('roc_exchange_rate')->end()
                ->arrayNode('preferred_choices')->end()
            ->end()
        ->end();

        return $node;
    }

    /**
     * Build configuration tree for "RunOpenCode\Bundle\ExchangeRate\Form\Type\RateType" default settings.
     *
     * @return ArrayNodeDefinition
     */
    protected function getRateTypeDefinition()
    {
        $node = new ArrayNodeDefinition('rate_type');

        $node
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
            ->info('Modify default "RunOpenCode\\Bundle\\ExchangeRate\\Form\\Type\\RateType" settings.')
            ->addDefaultsIfNotSet()
            ->children()
                ->scalarNode('choice_translation_domain')->defaultValue('roc_exchange_rate')->end()
                ->scalarNode('label_format')->defaultValue('{{currency-code}}, {{rate-type}} ({{source}})')->end()
                ->arrayNode('preferred_choices')->end()
            ->end()
        ->end();

        return $node;
    }
}

Push — master ( 7d1fce...9e821b )

Configuration::getAccessRolesDefinition() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

RunOpenCode / exchange-rate-bundle

Push — master ( 7d1fce...9e821b )

Configuration::getAccessRolesDefinition() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like
