Configuration::getConfigTreeBuilder() - Code Metrics - Inspection of "Bugfix, cast to int" - Happyr/GoogleSiteAuthenticatorBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 695ade...7ff83f )

by Tobias

created 2019-02-13 10:33 UTC

Configuration::getConfigTreeBuilder() A

↳ Parent: Configuration

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	2.004

Importance

Changes

Metric	Value
dl	0
loc	17
ccs	9
cts	10
cp	0.9
rs	9.7
c	0
b	0
f	0
cc	2
nc	2
nop	0
crap	2.004

<?php

namespace Happyr\GoogleSiteAuthenticatorBundle\DependencyInjection;

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

/**
 * This is the class that validates and merges configuration from your app/config files.
 */
class Configuration implements ConfigurationInterface
{
    /**
     * {@inheritdoc}
     */
    public function getConfigTreeBuilder()
    {
        $treeBuilder = new TreeBuilder('happyr_google_site_authenticator');
        // Keep compatibility with symfony/config < 4.2
        if (!method_exists($treeBuilder, 'getRootNode')) {
            $root = $treeBuilder->root('happyr_google_site_authenticator');
        } else {
            $root = $treeBuilder->getRootNode();
        }

        $root->children()
            ->scalarNode('cache_service')->cannotBeEmpty()->end()
            ->append($this->getTokenNode())
        ->end();

        return $treeBuilder;
    }

    /**
     * @return \Symfony\Component\Config\Definition\Builder\NodeDefinition
     */
    private function getTokenNode()
    {
        $treeBuilder = new TreeBuilder();
        $node = $treeBuilder->root('tokens');
        $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.
    }
}
            ->isRequired()
            ->requiresAtLeastOneElement()
            ->useAttributeAsKey('name')
            ->prototype('array')
            ->children()
                ->scalarNode('client_id')->isRequired()->end()
                ->scalarNode('client_secret')->isRequired()->end()
                ->scalarNode('redirect_url')->isRequired()->end()
                ->variableNode('scopes')->end()
            ->end()
        ->end();

        return $node;
    }
}


1		<?php
2
3		namespace Happyr\GoogleSiteAuthenticatorBundle\DependencyInjection;
4
5		use Symfony\Component\Config\Definition\Builder\TreeBuilder;
6		use Symfony\Component\Config\Definition\ConfigurationInterface;
7
8		/**
9		* This is the class that validates and merges configuration from your app/config files.
10		*/
11		class Configuration implements ConfigurationInterface
12		{
13		/**
14		* {@inheritdoc}
15		*/
16	2	public function getConfigTreeBuilder()
17		{
18	2	$treeBuilder = new TreeBuilder('happyr_google_site_authenticator');
19		// Keep compatibility with symfony/config < 4.2
20	2	if (!method_exists($treeBuilder, 'getRootNode')) {
21		$root = $treeBuilder->root('happyr_google_site_authenticator');
22		} else {
23	2	$root = $treeBuilder->getRootNode();
24		}
25
26	2	$root->children()
27	2	->scalarNode('cache_service')->cannotBeEmpty()->end()
28	2	->append($this->getTokenNode())
29	2	->end();
30
31	2	return $treeBuilder;
32		}
33
34		/**
35		* @return \Symfony\Component\Config\Definition\Builder\NodeDefinition
36		*/
37	2	private function getTokenNode()
38		{
39	2	$treeBuilder = new TreeBuilder();
40	2	$node = $treeBuilder->root('tokens');
41		$node
		0 ignored issues – show Bug introduced 2018-01-11 12:49 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Symfony\Component\Config...\Builder\NodeDefinition` as the method `children()` does only exist in the following sub-classes of `Symfony\Component\Config...\Builder\NodeDefinition`: `Symfony\Component\Config...der\ArrayNodeDefinition`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: 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. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
42	2	->isRequired()
43	2	->requiresAtLeastOneElement()
44	2	->useAttributeAsKey('name')
45	2	->prototype('array')
46	2	->children()
47	2	->scalarNode('client_id')->isRequired()->end()
48	2	->scalarNode('client_secret')->isRequired()->end()
49	2	->scalarNode('redirect_url')->isRequired()->end()
50	2	->variableNode('scopes')->end()
51	2	->end()
52	2	->end();
53
54	2	return $node;
55		}
56		}
57

Happyr / GoogleSiteAuthenticatorBundle

Push — master ( 695ade...7ff83f )

Configuration::getConfigTreeBuilder() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like