Configuration::getConfigTreeBuilder() - Code Metrics - Inspection of "Add receiver for resetting the services" - b2pweb/bdf-queue-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( c2b6eb...8c3bb9 )

by Sébastien
created 2022-06-01 15:21 UTC
Configuration::getConfigTreeBuilder() A

↳ Parent: Configuration
Complexity

Conditions	1
Paths	1
Size

Total Lines	18
Code Lines	14
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	15
CRAP Score	1
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	14
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	18
ccs	15
cts	15
cp	1
crap	1
rs	9.7998
<?php

namespace Bdf\QueueBundle\DependencyInjection;

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

/**
 * Configuration
 */
class Configuration implements ConfigurationInterface
{
    /**
     * @var bool
     */
    private $debug;

    /**
     * @param bool $debug Whether to use the debug mode
     */
    public function __construct($debug = false)
    {
        $this->debug = (bool) $debug;
    }

    /**
     * {@inheritDoc}
     */
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder('bdf_queue');
        $treeBuilder->getRootNode()
            ->children()
                ->scalarNode('default_connection')->defaultNull()->end()
                ->scalarNode('default_serializer')->defaultValue('bdf')->end()
                ->scalarNode('failer')
                    ->info('A DSN with failer configuration; Format: [memory|prime]://{connection}/{table}')
                    ->defaultValue('memory:')
                    ->cannotBeEmpty()
                ->end()
                ->append($this->getConnectionsNode())
                ->append($this->getDestinationsNode())
            ->end()
        ;

        return $treeBuilder;
    }

    /**
     * @return NodeDefinition
     */
    private function getConnectionsNode()
    {
        $root = (new TreeBuilder('connections'))->getRootNode();
        $root
            ->requiresAtLeastOneElement()
              requiresAtLeastOneElement()
            ->useAttributeAsKey('name')
            ->arrayPrototype()
            ->isRequired()
            ->beforeNormalization()
                ->ifString()
                ->then(static function ($v) {
                    return ['url' => $v];
                })
            ->end()
            ->children()
                ->scalarNode('url')
                    ->info('A URL with connection information; any parameter value parsed from this string will override explicitly set parameters. Format: {driver}+{vendor}://{user}:{password}@{host}:{port}/{queue}?{option}=value')
                    ->defaultNull()
                ->end()
                ->scalarNode('driver')->defaultNull()->end()
                ->scalarNode('vendor')->defaultNull()->end()
                ->scalarNode('queue')->defaultNull()->end()
                ->scalarNode('host')->defaultNull()->end()
                ->scalarNode('port')->defaultNull()->end()
                ->scalarNode('user')->defaultNull()->end()
                ->scalarNode('password')->defaultNull()->end()
                ->arrayNode('serializer')
                    ->addDefaultsIfNotSet()
                    ->beforeNormalization()
                        ->ifString()
                        ->then(static function ($v) {
                            return ['id' => $v];
                        })
                    ->end()
                    ->children()
                        ->scalarNode('id')
                            ->info('The serializer ID. This ID will be prefix by "bdf_queue.serializer". Defined values: native, bdf, bdf_json.')
                        ->end()
                        ->scalarNode('service')
                            ->info('The serializer service ID.')
                        ->end()
                    ->end()
                ->end()
                ->arrayNode('options')
                    ->useAttributeAsKey('key')
                    ->variablePrototype()->end()
                ->end()
                ->scalarNode('connection_factory')
                    ->defaultNull()
                ->end()
            ->end();

        return $root;
    }

    /**
     * @return NodeDefinition
     */
    private function getDestinationsNode()
    {
        $root = (new TreeBuilder('destinations'))->getRootNode();
        $root
            ->requiresAtLeastOneElement()
            ->useAttributeAsKey('name')
            ->arrayPrototype()
            ->isRequired()
            ->beforeNormalization()
                ->ifString()
                ->then(static function ($v) {
                    return ['url' => $v];
                })
            ->end()
            ->children()
                ->scalarNode('url')
                    ->info('A URL with destination information; Format: [queue|queues|topic]://{connection}/{queue}')
                    ->cannotBeEmpty()
                ->end()
                ->arrayNode('consumer')
                    ->children()
                        ->scalarNode('handler')
                            ->info('Set unique handler as outlet receiver')
                            ->defaultNull()->end()
                        ->scalarNode('retry')
                            ->info('Retry failed jobs (i.e. throwing an exception)')
                            ->defaultNull()->end()
                        ->scalarNode('max')
                            ->info('Limit the number of received message. When the limit is reached, the consumer is stopped')
                            ->defaultNull()->end()
                        ->scalarNode('limit')
                            ->info('Limit the received message rate')
                            ->defaultNull()->end()
                        ->scalarNode('memory')
                            ->info('Limit the total memory usage of the current runtime in bytes. When the limit is reached, the consumer is stopped')
                            ->defaultNull()->end()
                        ->booleanNode('save')
                            ->info('Store the failed messages')
                            ->defaultNull()->end()
                        ->booleanNode('no_failure')
                            ->info('Catch all exceptions to ensure that the consumer will no crash (and will silently fail)')
                            ->defaultNull()->end()
                        ->booleanNode('no_reset')
                            ->info('Disable the reset of services between messages.')
                            ->defaultNull()->end()
                        ->booleanNode('stop_when_empty')
                            ->info('Stops consumption when the destination is empty (i.e. no messages are received during the waiting duration)')
                            ->defaultNull()->end()
                        ->booleanNode('auto_handle')
                            ->info('Set auto discover as outlet receiver. The message should contain target hint.')
                            ->defaultNull()->end()
                        ->arrayNode('middlewares')
                            ->useAttributeAsKey('name')
                            ->variablePrototype()->end()
                        ->end()
                    ->end()
                ->end()
            ->end();

        return $root;
    }
}

b2pweb / bdf-queue-bundle

Push — master ( c2b6eb...8c3bb9 )

Configuration::getConfigTreeBuilder() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
