ReportCommand::execute() - Code Metrics - Inspection of "Merge branch 'release/1.3.3'" - netz98/n98-magerun2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( fb5c6c...3561cd )

by Tom

created 2017-03-03 13:33 UTC

ReportCommand::execute() C

↳ Parent: ReportCommand

Complexity

Conditions	13
Paths	57

Size

Total Lines	61
Code Lines	39

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	61
rs	6.2659
cc	13
eloc	39
nc	57
nop	2

How to fix Long Method Complexity

<?php

namespace N98\Magento\Command\Cache;

use Magento\Framework\App\CacheInterface;
use Magento\PageCache\Model\Cache\Type as FullPageCache;
use N98\Magento\Command\AbstractMagentoCommand;
use N98\Util\Console\Helper\Table\Renderer\RendererFactory;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Validator\Exception\RuntimeException;

class ReportCommand extends AbstractMagentoCommand
{
    /**
     * @var CacheInterface
     */
    private $cache;

    /**
     * @var FullPageCache
     */
    private $fpc;

    /**
     * @param CacheInterface $cache
     * @param FullPageCache $fpc
     */
    public function inject(
        CacheInterface $cache,
        FullPageCache $fpc
    ) {
        $this->cache = $cache;
        $this->fpc = $fpc;
    }

    /**
     * @return void
     */
    protected function configure()
    {
        $this
            ->setName('cache:report')
            ->addOption(
                'fpc',
                null,
                InputOption::VALUE_NONE,
                'Use full page cache instead of core cache'
            )
            ->addOption(
                'tags',
                't',
                InputOption::VALUE_NONE,
                'Output tags'
            )
            ->addOption(
                'mtime',
                'm',
                InputOption::VALUE_NONE,
                'Output last modification time'
            )
            ->addOption(
                'filter-id',
                '',
                InputOption::VALUE_OPTIONAL,
                'Filter output by ID (substring)'
            )
            ->addOption(
                'filter-tag',
                '',
                InputOption::VALUE_OPTIONAL,
                'Filter output by TAG (separate multiple tags by comma)'
            )
            ->addOption(
                'format',
                null,
                InputOption::VALUE_OPTIONAL,
                'Output Format. One of [' . implode(', ', RendererFactory::getFormats()) . ']'
            )
            ->setDescription('View inside the cache');
    }

    /**
     * @param InputInterface $input
     * @param OutputInterface $output
     * @return int|void
     * @throws RuntimeException
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $this->detectMagento($output, true);
        if (!$this->initMagento()) {
            return;
        }

        /** @var \Zend_Cache_Core $lowLevelFrontend */
        if ($input->hasOption('fpc') && $input->getOption('fpc')) {
            $lowLevelFrontend = $this->fpc->getLowLevelFrontend();
        } else {
            $lowLevelFrontend = $this->cache->getFrontend()->getLowLevelFrontend();
        }

        $table = [];
        $cacheIds = $lowLevelFrontend->getIds();
        $filterId = $input->getOption('filter-id');
        $filterTag = $input->getOption('filter-tag');
        $mTime = $input->getOption('mtime');
        $tags = $input->getOption('tags');
        foreach ($cacheIds as $cacheId) {
            if ($filterId !== null &&
                !stristr($cacheId, $filterId)) {
                continue;
            }

            $metadata = $lowLevelFrontend->getMetadatas($cacheId);
            if ($filterTag !== null &&
                !$this->isTagFiltered($metadata, $input)) {
                continue;
            }

            $row = [
                $cacheId,
                date('Y-m-d H:i:s', $metadata['expire']),
            ];

            if ($mTime) {
                $row[] = date('Y-m-d H:i:s', $metadata['mtime']);
            }

            if ($tags) {
                $row[] = implode(', ', $metadata['tags']);
            }

            $table[] = $row;
        }

        $headers = ['ID', 'EXPIRE'];
        if ($mTime) {
            $headers[] = 'MTIME';
        }
        if ($tags) {
            $headers[] = 'TAGS';
        }

        $this
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements 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.
    }
}
            ->getHelper('table')
            ->setHeaders($headers)
            ->renderByFormat($output, $table, $input->getOption('format'));
    }

    /**
     * @param array $metadata
     * @param InputInterface $input
     * @return bool
     */
    private function isTagFiltered($metadata, $input)
    {
        return (bool) count(
            array_intersect(
                $metadata['tags'],
                explode(',', $input->getOption('filter-tag'))
            )
        );
    }
}


1			<?php
2
3			namespace N98\Magento\Command\Cache;
4
5			use Magento\Framework\App\CacheInterface;
6			use Magento\PageCache\Model\Cache\Type as FullPageCache;
7			use N98\Magento\Command\AbstractMagentoCommand;
8			use N98\Util\Console\Helper\Table\Renderer\RendererFactory;
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\Validator\Exception\RuntimeException;
13
14			class ReportCommand extends AbstractMagentoCommand
15			{
16			/**
17			* @var CacheInterface
18			*/
19			private $cache;
20
21			/**
22			* @var FullPageCache
23			*/
24			private $fpc;
25
26			/**
27			* @param CacheInterface $cache
28			* @param FullPageCache $fpc
29			*/
30			public function inject(
31			CacheInterface $cache,
32			FullPageCache $fpc
33			) {
34			$this->cache = $cache;
35			$this->fpc = $fpc;
36			}
37
38			/**
39			* @return void
40			*/
41			protected function configure()
42			{
43			$this
44			->setName('cache:report')
45			->addOption(
46			'fpc',
47			null,
48			InputOption::VALUE_NONE,
49			'Use full page cache instead of core cache'
50			)
51			->addOption(
52			'tags',
53			't',
54			InputOption::VALUE_NONE,
55			'Output tags'
56			)
57			->addOption(
58			'mtime',
59			'm',
60			InputOption::VALUE_NONE,
61			'Output last modification time'
62			)
63			->addOption(
64			'filter-id',
65			'',
66			InputOption::VALUE_OPTIONAL,
67			'Filter output by ID (substring)'
68			)
69			->addOption(
70			'filter-tag',
71			'',
72			InputOption::VALUE_OPTIONAL,
73			'Filter output by TAG (separate multiple tags by comma)'
74			)
75			->addOption(
76			'format',
77			null,
78			InputOption::VALUE_OPTIONAL,
79			'Output Format. One of [' . implode(', ', RendererFactory::getFormats()) . ']'
80			)
81			->setDescription('View inside the cache');
82			}
83
84			/**
85			* @param InputInterface $input
86			* @param OutputInterface $output
87			* @return int\|void
88			* @throws RuntimeException
89			*/
90			protected function execute(InputInterface $input, OutputInterface $output)
91			{
92			$this->detectMagento($output, true);
93			if (!$this->initMagento()) {
94			return;
95			}
96
97			/** @var \Zend_Cache_Core $lowLevelFrontend */
98			if ($input->hasOption('fpc') && $input->getOption('fpc')) {
99			$lowLevelFrontend = $this->fpc->getLowLevelFrontend();
100			} else {
101			$lowLevelFrontend = $this->cache->getFrontend()->getLowLevelFrontend();
102			}
103
104			$table = [];
105			$cacheIds = $lowLevelFrontend->getIds();
106			$filterId = $input->getOption('filter-id');
107			$filterTag = $input->getOption('filter-tag');
108			$mTime = $input->getOption('mtime');
109			$tags = $input->getOption('tags');
110			foreach ($cacheIds as $cacheId) {
111			if ($filterId !== null &&
112			!stristr($cacheId, $filterId)) {
113			continue;
114			}
115
116			$metadata = $lowLevelFrontend->getMetadatas($cacheId);
117			if ($filterTag !== null &&
118			!$this->isTagFiltered($metadata, $input)) {
119			continue;
120			}
121
122			$row = [
123			$cacheId,
124			date('Y-m-d H:i:s', $metadata['expire']),
125			];
126
127			if ($mTime) {
128			$row[] = date('Y-m-d H:i:s', $metadata['mtime']);
129			}
130
131			if ($tags) {
132			$row[] = implode(', ', $metadata['tags']);
133			}
134
135			$table[] = $row;
136			}
137
138			$headers = ['ID', 'EXPIRE'];
139			if ($mTime) {
140			$headers[] = 'MTIME';
141			}
142			if ($tags) {
143			$headers[] = 'TAGS';
144			}
145
146			$this
			0 ignored issues – show Bug introduced 2017-03-01 19:43 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Symfony\Component\Console\Helper\HelperInterface` as the method `setHeaders()` does only exist in the following implementations of said interface: `N98\Util\Console\Helper\TableHelper`, `Symfony\Component\Console\Helper\TableHelper`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements 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 implementation 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 interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
147			->getHelper('table')
148			->setHeaders($headers)
149			->renderByFormat($output, $table, $input->getOption('format'));
150			}
151
152			/**
153			* @param array $metadata
154			* @param InputInterface $input
155			* @return bool
156			*/
157			private function isTagFiltered($metadata, $input)
158			{
159			return (bool) count(
160			array_intersect(
161			$metadata['tags'],
162			explode(',', $input->getOption('filter-tag'))
163			)
164			);
165			}
166			}
167

netz98 / n98-magerun2

Push — master ( fb5c6c...3561cd )

ReportCommand::execute() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like