LoadFeatureCommand::findFeatureNodes() - Code Metrics - Inspection of "Expand features discovering" - adespresso/FeatureBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#26)

by Emanuele

created 2017-03-22 06:45 UTC

LoadFeatureCommand::findFeatureNodes() B

↳ Parent: LoadFeatureCommand

Complexity

Conditions	6
Paths	6

Size

Total Lines	33
Code Lines	23

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	34.317

Importance

Changes

Metric	Value
dl	0
loc	33
ccs	2
cts	26
cp	0.0769
rs	8.439
c	0
b	0
f	0
cc	6
eloc	23
nc	6
nop	1
crap	34.317

<?php

namespace Ae\FeatureBundle\Command;

use Ae\FeatureBundle\Twig\Node\FeatureNode;
use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
use Symfony\Bundle\FrameworkBundle\Console\Application;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Finder\Finder;
use Twig_Node;
use Twig_Source;

/**
 * @author Carlo Forghieri <[email protected]>
 */
class LoadFeatureCommand extends ContainerAwareCommand
{
    /**
     * {@inheritdoc}
     */
    protected function configure()
    {
        $this
            ->setName('features:load')
            ->setDescription('Persist new features found in templates')
            ->addArgument(
                'path',
                InputArgument::REQUIRED | InputArgument::IS_ARRAY,
                'The path or bundle where to load the features'
            )
            ->addOption(
                'dry-run',
                null,
                InputOption::VALUE_NONE,
                'Do not persist new features'
            );
    }

    /**
     * {@inheritdoc}
     */
    public function execute(InputInterface $input, OutputInterface $output)
    {
        $container = $this->getContainer();
        $twig = $container->get('twig');
        $files = $this->getFinderInstance($input->getArgument('path'));

        $found = [];
        foreach ($files as $file) {
            $tree = $twig->parse($twig->tokenize(new Twig_Source(
                file_get_contents($file->getPathname()),
                $file->getFilename(),
                $file->getPathname()
            )));
            $tags = $this->findFeatureNodes($tree);

            if (empty($tags)) {
                continue;
            }

            $found = array_merge($found, $tags);

            foreach ($tags as $tag) {
                $output->writeln(sprintf(
                    'Found <info>%s</info>.<info>%s</info> in <info>%s</info>',
                    $tag['parent'],
                    $tag['name'],
                    $file->getFilename()
                ));
            }
        }

        if ($input->getOption('dry-run')) {
            return;
        }

        $manager = $container->get('ae_feature.manager');
        foreach ($found as $tag) {
            $manager->findOrCreate($tag['name'], $tag['parent']);
        }
    }

    /**
     * Find feature nodes.
     *
     * @param Twig_Node $node
     *
     * @return array
     */
    private function findFeatureNodes(Twig_Node $node)
    {
        $found = [];
        $stack = [$node];
        while ($stack) {

            $node = array_pop($stack);
            if ($node instanceof FeatureNode) {
                $arguments = $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.
    }
}
                    ->getNode('tests')
                    ->getNode(0)
                    ->getNode('arguments')
                    ->getKeyValuePairs();

                $tag = [];
                foreach ($arguments as $argument) {
                    $keyAttr = $argument['key']->getAttribute('value');
                    $valueAttr = $argument['value']->getAttribute('value');

                    $tag[$keyAttr] = $valueAttr;
                }
                $key = md5(serialize($tag));
                $found[$key] = $tag;
            } else {
                foreach ($node as $child) {
                    if (null !== $child) {
                        $stack[] = $child;
                    }
                }
            }
        }

        return array_values($found);
    }

    /**
     * Gets a Finder instance with required paths.
     *
     * @param array $dirsOrBundles Required directories or bundles
     *
     * @return Finder
     */
    private function getFinderInstance(array $dirsOrBundles)
    {
        $finder = new Finder();
        $application = $this->getApplication();

        $kernel = null;
        $bundles = [];
        if ($application instanceof Application) {
            $kernel = $application->getKernel();
            $bundles = $kernel->getBundles();
        }

        foreach ($dirsOrBundles as $dirOrBundle) {
            if (null !== $kernel && isset($bundles[$dirOrBundle])) {
                $bundle = $kernel->getBundle($dirOrBundle);
                $dirOrBundle = $bundle->getPath().'/Resources/views/';
            }

            $finder->in($dirOrBundle);
        }

        return $finder
            ->files()
            ->name('*.twig');
    }
}


1		<?php
2
3		namespace Ae\FeatureBundle\Command;
4
5		use Ae\FeatureBundle\Twig\Node\FeatureNode;
6		use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
7		use Symfony\Bundle\FrameworkBundle\Console\Application;
8		use Symfony\Component\Console\Input\InputArgument;
9		use Symfony\Component\Console\Input\InputInterface;
10		use Symfony\Component\Console\Input\InputOption;
11		use Symfony\Component\Console\Output\OutputInterface;
12		use Symfony\Component\Finder\Finder;
13		use Twig_Node;
14		use Twig_Source;
15
16		/**
17		* @author Carlo Forghieri <[email protected]>
18		*/
19		class LoadFeatureCommand extends ContainerAwareCommand
20		{
21		/**
22		* {@inheritdoc}
23		*/
24	2	protected function configure()
25		{
26	2	$this
27	2	->setName('features:load')
28	2	->setDescription('Persist new features found in templates')
29	2	->addArgument(
30	2	'path',
31	2	InputArgument::REQUIRED \| InputArgument::IS_ARRAY,
32		'The path or bundle where to load the features'
33	2	)
34	2	->addOption(
35	2	'dry-run',
36	2	null,
37	2	InputOption::VALUE_NONE,
38		'Do not persist new features'
39	2	);
40	2	}
41
42		/**
43		* {@inheritdoc}
44		*/
45	2	public function execute(InputInterface $input, OutputInterface $output)
46		{
47	2	$container = $this->getContainer();
48	2	$twig = $container->get('twig');
49	2	$files = $this->getFinderInstance($input->getArgument('path'));
50
51	2	$found = [];
52	2	foreach ($files as $file) {
53		$tree = $twig->parse($twig->tokenize(new Twig_Source(
54		file_get_contents($file->getPathname()),
55		$file->getFilename(),
56		$file->getPathname()
57		)));
58		$tags = $this->findFeatureNodes($tree);
59
60		if (empty($tags)) {
61		continue;
62		}
63
64		$found = array_merge($found, $tags);
65
66		foreach ($tags as $tag) {
67		$output->writeln(sprintf(
68		'Found <info>%s</info>.<info>%s</info> in <info>%s</info>',
69		$tag['parent'],
70		$tag['name'],
71		$file->getFilename()
72		));
73		}
74	1	}
75
76	1	if ($input->getOption('dry-run')) {
77		return;
78		}
79
80	1	$manager = $container->get('ae_feature.manager');
81	1	foreach ($found as $tag) {
82		$manager->findOrCreate($tag['name'], $tag['parent']);
83	1	}
84	1	}
85
86		/**
87		* Find feature nodes.
88		*
89		* @param Twig_Node $node
90		*
91		* @return array
92		*/
93	1	private function findFeatureNodes(Twig_Node $node)
94		{
95		$found = [];
96		$stack = [$node];
97		while ($stack) {
		0 ignored issues – show Bug Best Practice introduced 2016-01-25 08:35 UTC by Report Bug Copy Issue Report The expression `$stack` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
98		$node = array_pop($stack);
99		if ($node instanceof FeatureNode) {
100		$arguments = $node
		0 ignored issues – show Bug introduced 2016-03-31 23:11 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Twig_Node` as the method `getKeyValuePairs()` does only exist in the following sub-classes of `Twig_Node`: `Twig_Node_Expression_Array`. 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...
101	1	->getNode('tests')
102		->getNode(0)
103		->getNode('arguments')
104		->getKeyValuePairs();
105
106		$tag = [];
107		foreach ($arguments as $argument) {
108		$keyAttr = $argument['key']->getAttribute('value');
109		$valueAttr = $argument['value']->getAttribute('value');
110
111		$tag[$keyAttr] = $valueAttr;
112		}
113		$key = md5(serialize($tag));
114		$found[$key] = $tag;
115		} else {
116		foreach ($node as $child) {
117		if (null !== $child) {
118		$stack[] = $child;
119		}
120		}
121		}
122		}
123
124		return array_values($found);
125		}
126
127		/**
128		* Gets a Finder instance with required paths.
129		*
130		* @param array $dirsOrBundles Required directories or bundles
131		*
132		* @return Finder
133		*/
134	2	private function getFinderInstance(array $dirsOrBundles)
135		{
136	2	$finder = new Finder();
137	2	$application = $this->getApplication();
138
139	2	$kernel = null;
140	2	$bundles = [];
141	2	if ($application instanceof Application) {
142	2	$kernel = $application->getKernel();
143	2	$bundles = $kernel->getBundles();
144	2	}
145
146	2	foreach ($dirsOrBundles as $dirOrBundle) {
147	1	if (null !== $kernel && isset($bundles[$dirOrBundle])) {
148		$bundle = $kernel->getBundle($dirOrBundle);
149		$dirOrBundle = $bundle->getPath().'/Resources/views/';
150		}
151
152	1	$finder->in($dirOrBundle);
153	2	}
154
155		return $finder
156	2	->files()
157	2	->name('*.twig');
158		}
159		}
160

adespresso / FeatureBundle

Pull Request — master (#26)

LoadFeatureCommand::findFeatureNodes() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like