ThemeConfiguration::addOptionalPathField() - Code Metrics - Inspection of "Merge pull request #424 from ahilles107/SWP-938_th..." - superdesk/web-publisher - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 7a069b...4da1f4 )

by Paweł
created 2018-01-23 20:12 UTC
ThemeConfiguration::addOptionalPathField() A

↳ Parent: ThemeConfiguration
Complexity

Conditions	1
Paths	1
Size

Total Lines	4
Code Lines	2
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	2
CRAP Score	1
Importance

Changes
Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1
crap	1
<?php

/*
 * This file is part of the Superdesk Web Publisher Core Bundle.
 *
 * Copyright 2016 Sourcefabric z.u. and contributors.
 *
 * For the full copyright and license information, please see the
 * AUTHORS and LICENSE files distributed with this source code.
 *
 * @copyright 2016 Sourcefabric z.ú
 * @license http://www.superdesk.org/license
 *
 *
 * This file is part of the Sylius package.
 *
 * (c) Paweł Jędrzejewski
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace SWP\Bundle\CoreBundle\Theme\Configuration;

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

/**
 * @author Kamil Kokot <[email protected]>
 * @author Paweł Mikołajczuk <[email protected]>
 */
final class ThemeConfiguration implements ConfigurationInterface
{
    /**
     * {@inheritdoc}
     */
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder();
        $rootNodeDefinition = $treeBuilder->root('sylius_theme');

        $rootNodeDefinition->ignoreExtraKeys();

        $this->addRequiredNameField($rootNodeDefinition);
        $this->addOptionalTitleField($rootNodeDefinition);
        $this->addOptionalDescriptionField($rootNodeDefinition);
        $this->addOptionalPathField($rootNodeDefinition);
        $this->addOptionalParentsList($rootNodeDefinition);
        $this->addOptionalScreenshotsList($rootNodeDefinition);
        $this->addOptionalAuthorsList($rootNodeDefinition);
        $this->addOptionalConfig($rootNodeDefinition);
        $this->addOptionalGeneratedData($rootNodeDefinition);

        return $treeBuilder;
    }

    /**
     * @param ArrayNodeDefinition $rootNodeDefinition
     */
    private function addRequiredNameField(ArrayNodeDefinition $rootNodeDefinition)
    {
        $rootNodeDefinition->children()->scalarNode('name')->isRequired()->cannotBeEmpty();
    }

    /**
     * @param ArrayNodeDefinition $rootNodeDefinition
     */
    private function addOptionalTitleField(ArrayNodeDefinition $rootNodeDefinition)
    {
        $rootNodeDefinition->children()->scalarNode('title')->cannotBeEmpty();
    }

    /**
     * @param ArrayNodeDefinition $rootNodeDefinition
     */
    private function addOptionalDescriptionField(ArrayNodeDefinition $rootNodeDefinition)
    {
        $rootNodeDefinition->children()->scalarNode('description')->cannotBeEmpty();
    }

    /**
     * @param ArrayNodeDefinition $rootNodeDefinition
     */
    private function addOptionalPathField(ArrayNodeDefinition $rootNodeDefinition)
    {
        $rootNodeDefinition->children()->scalarNode('path')->cannotBeEmpty();
    }

    /**
     * @param ArrayNodeDefinition $rootNodeDefinition
     */
    private function addOptionalParentsList(ArrayNodeDefinition $rootNodeDefinition)
    {
        $parentsNodeDefinition = $rootNodeDefinition->children()->arrayNode('parents');
        $parentsNodeDefinition
            ->requiresAtLeastOneElement()
            ->performNoDeepMerging()
            ->prototype('scalar')
            ->cannotBeEmpty()
        ;
    }

    /**
     * @param ArrayNodeDefinition $rootNodeDefinition
     */
    private function addOptionalConfig(ArrayNodeDefinition $rootNodeDefinition)
    {
        $configNodeDefinition = $rootNodeDefinition->children()->arrayNode('config');
        $configNodeDefinition
            ->requiresAtLeastOneElement()
            ->performNoDeepMerging()
            ->prototype('variable')
        ;

        $configNodeDefinition->children()->variableNode('defaultTemplates');
    }

    /**
     * @param ArrayNodeDefinition $rootNodeDefinition
     */
    private function addOptionalGeneratedData(ArrayNodeDefinition $rootNodeDefinition)
    {
        $generatedDataNodeDefinition = $rootNodeDefinition->children()->arrayNode('generatedData');
        $this->addOptionalGeneratedRoutesData($generatedDataNodeDefinition);
        $this->addOptionalGeneratedMenusData($generatedDataNodeDefinition);
        $this->addOptionalGeneratedContainersData($generatedDataNodeDefinition);
        $this->addOptionalGeneratedWidgetsData($generatedDataNodeDefinition);
        $this->addOptionalGenerateContentListsData($generatedDataNodeDefinition);
    }

    /**
     * @param ArrayNodeDefinition $generatedDataNodeDefinition
     */
    private function addOptionalGeneratedRoutesData(ArrayNodeDefinition $generatedDataNodeDefinition)
    {
        $routesNodeDefinition = $generatedDataNodeDefinition->children()->arrayNode('routes');
        $routesNodeDefinition->requiresAtLeastOneElement();

        /** @var ArrayNodeDefinition $routeNodeDefinition */
        $routeNodeDefinition = $routesNodeDefinition->prototype('array');
        $routeNodeDefinition
            ->validate()
            ->ifTrue(function ($route) {
                return [] === $route;
            })
            ->thenInvalid('Route cannot be empty!')
        ;

        $routeNodeBuilder = $routeNodeDefinition->children();
        $routeNodeBuilder->scalarNode('name')->cannotBeEmpty();
        $routeNodeBuilder->scalarNode('slug')->cannotBeEmpty();
        $routeNodeBuilder->scalarNode('type')->cannotBeEmpty();
        $routeNodeBuilder->scalarNode('parent')->defaultNull();
        $routeNodeBuilder->scalarNode('templateName')->defaultNull();
        $routeNodeBuilder->scalarNode('articlesTemplateName')->defaultNull();
        $routeNodeBuilder->scalarNode('numberOfArticles')->defaultNull();
    }

    /**
     * @param ArrayNodeDefinition $generatedDataNodeDefinition
     */
    private function addOptionalGeneratedMenusData(ArrayNodeDefinition $generatedDataNodeDefinition)
    {
        $menusNodeDefinition = $generatedDataNodeDefinition->children()->arrayNode('menus');
        $menusNodeDefinition->requiresAtLeastOneElement();

        /** @var ArrayNodeDefinition $menuNodeDefinition */
        $menuNodeDefinition = $menusNodeDefinition->prototype('array');
        $menuNodeDefinition
            ->validate()
            ->ifTrue(function ($menu) {
                return [] === $menu;
            })
            ->thenInvalid('Menu cannot be empty!')
        ;

        $menuNodeBuilder = $menuNodeDefinition->children();
        $menuNodeBuilder->scalarNode('name')->cannotBeEmpty()->end();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        $menuNodeBuilder->scalarNode('label')->cannotBeEmpty()->end();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        $menuNodeBuilder->scalarNode('uri')->cannotBeEmpty()->end();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        $menuNodeBuilder->scalarNode('route')->cannotBeEmpty()->defaultNull()->end();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}

        // 1st level of children
        $childrensNodeDefinition = $menuNodeBuilder->arrayNode('children');
        /** @var ArrayNodeDefinition $childrenNodeDefinition */
        $childrenNodeDefinition = $childrensNodeDefinition->prototype('array');
        $childrenNodeDefinition
            ->validate()
            ->ifTrue(function ($menu) {
                return [] === $menu;
            })
            ->thenInvalid('Menu cannot be empty!')
        ;

        $childrenNodeBuilder = $childrenNodeDefinition->children();
        $childrenNodeBuilder->scalarNode('name')->cannotBeEmpty()->end();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        $childrenNodeBuilder->scalarNode('label')->cannotBeEmpty()->end();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        $childrenNodeBuilder->scalarNode('uri')->cannotBeEmpty()->end();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        $childrenNodeBuilder->scalarNode('route')->cannotBeEmpty()->defaultNull()->end();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}

        // 2nd level of children
        $childrensChildrensNodeDefinition = $childrenNodeBuilder->arrayNode('children');
        /** @var ArrayNodeDefinition $childrensChildrenNodeDefinition */
        $childrensChildrenNodeDefinition = $childrensChildrensNodeDefinition->prototype('array');
        $childrensChildrenNodeDefinition
            ->validate()
            ->ifTrue(function ($menu) {
                return [] === $menu;
            })
            ->thenInvalid('Menu cannot be empty!')
        ;

        $childrenNodeBuilder = $childrensChildrenNodeDefinition->children();
        $childrenNodeBuilder->scalarNode('name')->cannotBeEmpty()->end();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        $childrenNodeBuilder->scalarNode('label')->cannotBeEmpty()->end();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        $childrenNodeBuilder->scalarNode('uri')->cannotBeEmpty()->end();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        $childrenNodeBuilder->scalarNode('route')->cannotBeEmpty()->defaultNull()->end();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
    }

    /**
     * @param ArrayNodeDefinition $generatedDataNodeDefinition
     */
    private function addOptionalGeneratedContainersData(ArrayNodeDefinition $generatedDataNodeDefinition)
    {
        $containersNodeDefinition = $generatedDataNodeDefinition->children()->arrayNode('containers');
        $containersNodeDefinition->requiresAtLeastOneElement();

        /** @var ArrayNodeDefinition $containerNodeDefinition */
        $containerNodeDefinition = $containersNodeDefinition->prototype('array');
        $containerNodeDefinition
            ->validate()
            ->ifTrue(function ($widget) {
                return [] === $widget;
            })
            ->thenInvalid('Widget cannot be empty!')
        ;

        $widgetNodeBuilder = $containerNodeDefinition->children();
        $widgetNodeBuilder->scalarNode('name')->cannotBeEmpty()->end();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        $widgetNodeBuilder->scalarNode('styles')->cannotBeEmpty()->end();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        $widgetNodeBuilder->booleanNode('visible')->defaultTrue()->end();
        $widgetNodeBuilder->variableNode('data')->cannotBeEmpty()->end();
        $widgetNodeBuilder->scalarNode('cssClass')->cannotBeEmpty()->end();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
    }

    private function addOptionalGenerateContentListsData(ArrayNodeDefinition $generatedDataNodeDefinition)

    {
        $containersNodeDefinition = $generatedDataNodeDefinition->children()->arrayNode('contentLists');
        $containersNodeDefinition->requiresAtLeastOneElement();

        /** @var ArrayNodeDefinition $containerNodeDefinition */
        $containerNodeDefinition = $containersNodeDefinition->prototype('array');
        $containerNodeDefinition
            ->validate()
            ->ifTrue(function ($widget) {
                return [] === $widget;
            })
            ->thenInvalid('Content List cannot be empty!')
        ;

        $widgetNodeBuilder = $containerNodeDefinition->children();
        $widgetNodeBuilder->scalarNode('name')->cannotBeEmpty()->end();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        $widgetNodeBuilder->scalarNode('type')->cannotBeEmpty()->end();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        $widgetNodeBuilder->scalarNode('description')->defaultNull()->end();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        $widgetNodeBuilder->scalarNode('limit')->defaultNull()->end();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        $widgetNodeBuilder->scalarNode('cacheLifeTime')->defaultNull()->end();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
        $widgetNodeBuilder->scalarNode('filters')->defaultNull()->end();
class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}
    }

    private function addOptionalGeneratedWidgetsData(ArrayNodeDefinition $generatedDataNodeDefinition)

    {
        $widgetsNodeDefinition = $generatedDataNodeDefinition->children()->arrayNode('widgets');
        $widgetsNodeDefinition->requiresAtLeastOneElement();

        /** @var ArrayNodeDefinition $menuNodeDefinition */
        $widgetNodeDefinition = $widgetsNodeDefinition->prototype('array');
        $widgetNodeDefinition
            ->validate()
            ->ifTrue(function ($widget) {
                return [] === $widget;
            })
            ->thenInvalid('Widget cannot be empty!')
        ;

        $widgetNodeBuilder = $widgetNodeDefinition->children();
        $widgetNodeBuilder->scalarNode('name')->cannotBeEmpty()->end();
        $widgetNodeBuilder->scalarNode('type')->cannotBeEmpty()->end();
        $widgetNodeBuilder->booleanNode('visible')->defaultTrue()->end();
        $widgetNodeBuilder->variableNode('parameters')->cannotBeEmpty()->end();
        $widgetNodeBuilder->arrayNode('containers')->requiresAtLeastOneElement()->prototype('scalar')->end();
    }

    /**
     * @param ArrayNodeDefinition $rootNodeDefinition
     */
    private function addOptionalScreenshotsList(ArrayNodeDefinition $rootNodeDefinition)
    {
        $screenshotsNodeDefinition = $rootNodeDefinition->children()->arrayNode('screenshots');
        $screenshotsNodeDefinition
            ->requiresAtLeastOneElement()
            ->performNoDeepMerging()
        ;

        /** @var ArrayNodeDefinition $screenshotNodeDefinition */
        $screenshotNodeDefinition = $screenshotsNodeDefinition->prototype('array');

        $screenshotNodeDefinition
            ->validate()
            ->ifTrue(function ($screenshot) {
                return [] === $screenshot || ['path' => ''] === $screenshot;
            })
            ->thenInvalid('Screenshot cannot be empty!')
        ;
        $screenshotNodeDefinition
            ->beforeNormalization()
            ->ifString()
            ->then(function ($value) {
                return ['path' => $value];
            })
        ;

        $screenshotNodeBuilder = $screenshotNodeDefinition->children();
        $screenshotNodeBuilder->scalarNode('path')->isRequired();
        $screenshotNodeBuilder->scalarNode('title')->cannotBeEmpty();
        $screenshotNodeBuilder->scalarNode('description')->cannotBeEmpty();
    }

    /**
     * @param ArrayNodeDefinition $rootNodeDefinition
     */
    private function addOptionalAuthorsList(ArrayNodeDefinition $rootNodeDefinition)
    {
        $authorsNodeDefinition = $rootNodeDefinition->children()->arrayNode('authors');
        $authorsNodeDefinition
            ->requiresAtLeastOneElement()
            ->performNoDeepMerging()
        ;

        /** @var ArrayNodeDefinition $authorNodeDefinition */
        $authorNodeDefinition = $authorsNodeDefinition->prototype('array');
        $authorNodeDefinition
            ->validate()
            ->ifTrue(function ($author) {
                return [] === $author;
            })
            ->thenInvalid('Author cannot be empty!')
        ;

        $authorNodeBuilder = $authorNodeDefinition->children();
        $authorNodeBuilder->scalarNode('name')->cannotBeEmpty();
        $authorNodeBuilder->scalarNode('email')->cannotBeEmpty();
        $authorNodeBuilder->scalarNode('homepage')->cannotBeEmpty();
        $authorNodeBuilder->scalarNode('role')->cannotBeEmpty();
    }
}

1		<?php
2
3		/*
4		* This file is part of the Superdesk Web Publisher Core Bundle.
5		*
6		* Copyright 2016 Sourcefabric z.u. and contributors.
7		*
8		* For the full copyright and license information, please see the
9		* AUTHORS and LICENSE files distributed with this source code.
10		*
11		* @copyright 2016 Sourcefabric z.ú
12		* @license http://www.superdesk.org/license
13		*
14		*
15		* This file is part of the Sylius package.
16		*
17		* (c) Paweł Jędrzejewski
18		*
19		* For the full copyright and license information, please view the LICENSE
20		* file that was distributed with this source code.
21		*/
22
23		namespace SWP\Bundle\CoreBundle\Theme\Configuration;
24
25		use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
26		use Symfony\Component\Config\Definition\Builder\TreeBuilder;
27		use Symfony\Component\Config\Definition\ConfigurationInterface;
28
29		/**
30		* @author Kamil Kokot <[email protected]>
31		* @author Paweł Mikołajczuk <[email protected]>
32		*/
33		final class ThemeConfiguration implements ConfigurationInterface
34		{
35		/**
36		* {@inheritdoc}
37		*/
38	101	public function getConfigTreeBuilder()
39		{
40	101	$treeBuilder = new TreeBuilder();
superdesk / web-publisher

Push — master ( 7a069b...4da1f4 )

ThemeConfiguration::addOptionalPathField() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
