N98\Magento\Command\Developer\Theme\DuplicatesCommand

Complexity

Total Complexity

13

Size/Duplication

Total Lines	124
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Importance

Changes	3
Bugs	2	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
B	configure()	0	25	1
C	execute()	0	34	7
A	getChecksums()	0	20	3
A	logJUnit()	0	23	2

<?php

namespace N98\Magento\Command\Developer\Theme;

use N98\Magento\Command\AbstractMagentoCommand;
use N98\JUnitXml\Document as JUnitXmlDocument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Finder\Finder;

class DuplicatesCommand extends AbstractMagentoCommand
{
    protected function configure()
    {
        $this
            ->setName('dev:theme:duplicates')
            ->addArgument('theme', InputArgument::REQUIRED, 'Your theme')
            ->addArgument(
                'originalTheme',
                InputArgument::OPTIONAL,
                'Original theme to comapre. Default is "base/default"',
                'base/default'
            )
            ->addOption(
                'log-junit',
                null,
                InputOption::VALUE_REQUIRED,
                'Log duplicates in JUnit XML format to defined file.'
            )
            ->setDescription('Find duplicate files (templates, layout, locale, etc.) between two themes.')
        ;

        $help = <<<HELP
* If a filename with `--log-junit` option is set the tool generates an XML file and no output to *stdout*.
HELP;
        $this->setHelp($help);
    }

    /**
     * @param InputInterface  $input
     * @param OutputInterface $output
     *
     * @return int|void
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $time = microtime(true);
        $this->detectMagento($output);
        if ($this->_magentoMajorVersion == self::MAGENTO_MAJOR_VERSION_2) {
            $output->writeln('<error>Magento 2 is currently not supported.</error>');
        } else {
            $referenceFiles = $this->getChecksums(
                $this->_magentoRootFolder . '/app/design/frontend/' . $input->getArgument('originalTheme')
            );

            $themeFolder = $this->_magentoRootFolder . '/app/design/frontend/' . $input->getArgument('theme');
            $themeFiles = $this->getChecksums($themeFolder);

            $duplicates = array();
            foreach ($themeFiles as $themeFilename => $themeFileChecksum) {
                if (isset($referenceFiles[$themeFilename])
                    && $themeFileChecksum == $referenceFiles[$themeFilename]
                ) {
                    $duplicates[] = $themeFolder . '/' . $themeFilename;
                }
            }

            if ($input->getOption('log-junit')) {
                $this->logJUnit($input, $duplicates, $input->getOption('log-junit'), microtime($time) - $time);
            } else {
                if (count($duplicates) === 0) {
                    $output->writeln('<info>No duplicates were found</info>');
                } else {
                    $output->writeln($duplicates);
                }
            }
        }
    }

    /**
     * @param string $baseFolder
     * @return array
     */
    protected function getChecksums($baseFolder)
    {
        $finder = Finder::create();
        $finder
            ->files()
            ->ignoreUnreadableDirs(true)
            ->ignoreDotFiles(true)
            ->ignoreVCS(true)
            ->followLinks()
            ->in($baseFolder);
        $checksums = array();
        foreach ($finder as $file) {
            /* @var $file \Symfony\Component\Finder\SplFileInfo */
            if (file_exists($file->getRealPath())) {
                $checksums[$file->getRelativePathname()] = md5_file($file->getRealPath());
            }
        }

        return $checksums;
    }

    /**
     * @param InputInterface $input
     * @param array          $duplicates
     * @param string         $filename
     * @param float          $duration
     */
    protected function logJUnit($input, array $duplicates, $filename, $duration)
    {
        $document = new JUnitXmlDocument();
        $suite = $document->addTestSuite();
        $suite->setName('n98-magerun: ' . $this->getName());
        $suite->setTimestamp(new \DateTime());
        $suite->setTime($duration);

        $testCase = $suite->addTestCase();
        $testCase->setName(
            'Magento Duplicate Theme Files: ' . $input->getArgument('theme') . ' | ' .
            $input->getArgument('originalTheme')
        );
        $testCase->setClassname('ConflictsCommand');
        foreach ($duplicates as $duplicate) {
            $testCase->addFailure(
                sprintf('Duplicate File: %s', $duplicate),
                'MagentoThemeDuplicateFileException'
            );
        }

        $document->save($filename);
    }
}