RemoveMissingEmbeddedImagesCommand::getArticlesByBodyContent() - Code Metrics - Inspection of "Merge pull request #1082 from ahilles107/remove_br..." - superdesk/web-publisher - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 2.1 ( 236a62...b86345 )

by Paweł

created 2020-03-27 09:08 UTC

getArticlesByBodyContent() A

↳ Parent: RemoveMissingEmbeddedImagesCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.9332
c	0
b	0
f	0
cc	1
nc	1
nop	3

<?php

declare(strict_types=1);

/*
 * This file is part of the Superdesk Web Publisher Core Bundle.
 *
 * Copyright 2019 Sourcefabric z.ú. and contributors.
 *
 * For the full copyright and license information, please see the
 * AUTHORS and LICENSE files distributed with this source code.
 *
 * @copyright 2019 Sourcefabric z.ú
 * @license http://www.superdesk.org/license
 */

namespace SWP\Bundle\CoreBundle\Command;

use Doctrine\ORM\EntityManagerInterface;
use SWP\Bundle\ContentBundle\Model\ArticleInterface;
use SWP\Bundle\CoreBundle\Model\Article;
use SWP\Bundle\CoreBundle\Repository\ArticleRepositoryInterface;
use Symfony\Component\Console\Command\Command;
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\DomCrawler\Crawler;

class RemoveMissingEmbeddedImagesCommand extends Command
{
    protected static $defaultName = 'swp:fixer:remove-missing-embedded-images';

    private $entityManager;

    private $articleRepository;

    public function __construct(
        EntityManagerInterface $entityManager,
        ArticleRepositoryInterface $articleRepository
    ) {
        parent::__construct();

        $this->entityManager = $entityManager;
        $this->articleRepository = $articleRepository;
    }

    protected function configure(): void
    {
        $this
            ->setName(self::$defaultName)
            ->setDescription('Remove from article body missing embedded images')
            ->addOption('dry-run', null, InputOption::VALUE_NONE, 'Do not execute anything, just show what was found')
            ->addOption('limit', null, InputOption::VALUE_REQUIRED, 'Limit for searched articles')
            ->addArgument('term', InputArgument::REQUIRED, 'Article body fragment')
            ->addArgument('parent', InputArgument::REQUIRED, 'Found element parent to be removed');
    }

    protected function execute(InputInterface $input, OutputInterface $output): int
    {
        $limit = 2000;
        if (null !== $input->getOption('limit')) {
            $limit = (int) $input->getOption('limit');
        }
        /** @var ArticleInterface[] $brokenArticles */
        $brokenArticles = $this->getArticlesByBodyContent($this->entityManager, $input->getArgument('term'), $limit);

        foreach ($brokenArticles as $article) {
            $output->writeln(sprintf('Cleaning article: %s', $article->getTitle()));
            $articleBody = $article->getBody();
            $crawler = new Crawler($articleBody);
            $crawler->filter('img')
                ->reduce(function (Crawler $node, $i) use ($input) {

                    if (false === strpos($node->attr('src'), $input->getArgument('term'))) {
                        return false;
                    }
                })
                ->each(static function (Crawler $crawler, $i) use ($input) {

                    $closest = $crawler->closest($input->getArgument('parent'));

                    if (is_iterable($closest)) {
                        foreach ($closest as $node) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                            $node->parentNode->removeChild($node);
                        }
                    }
                });

            $newContent = $crawler->filter('html body')->each(static function (Crawler $crawler) {
                return $crawler->html();
            });

            $article->setBody(implode('', $newContent));
        }

        if (true !== $input->getOption('dry-run')) {
            $this->entityManager->flush();
        }

        $output->writeln('<bg=green;options=bold>Done. In total processed '.\count($brokenArticles).' articles.</>');

        return 0;
    }

    private function getArticlesByBodyContent(EntityManagerInterface $manager, string $content, int $limit): array
    {
        $queryBuilder = $manager->createQueryBuilder();
        $queryBuilder->select('a')->from(Article::class, 'a');
        $like = $queryBuilder->expr()->like('a.body', $queryBuilder->expr()->literal('%'.$content.'%'));
        $queryBuilder->andWhere($like);
        $queryBuilder->setMaxResults($limit);

        return $queryBuilder->getQuery()->getResult();
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Superdesk Web Publisher Core Bundle.
7			*
8			* Copyright 2019 Sourcefabric z.ú. and contributors.
9			*
10			* For the full copyright and license information, please see the
11			* AUTHORS and LICENSE files distributed with this source code.
12			*
13			* @copyright 2019 Sourcefabric z.ú
14			* @license http://www.superdesk.org/license
15			*/
16
17			namespace SWP\Bundle\CoreBundle\Command;
18
19			use Doctrine\ORM\EntityManagerInterface;
20			use SWP\Bundle\ContentBundle\Model\ArticleInterface;
21			use SWP\Bundle\CoreBundle\Model\Article;
22			use SWP\Bundle\CoreBundle\Repository\ArticleRepositoryInterface;
23			use Symfony\Component\Console\Command\Command;
24			use Symfony\Component\Console\Input\InputArgument;
25			use Symfony\Component\Console\Input\InputInterface;
26			use Symfony\Component\Console\Input\InputOption;
27			use Symfony\Component\Console\Output\OutputInterface;
28			use Symfony\Component\DomCrawler\Crawler;
29
30			class RemoveMissingEmbeddedImagesCommand extends Command
31			{
32			protected static $defaultName = 'swp:fixer:remove-missing-embedded-images';
33
34			private $entityManager;
35
36			private $articleRepository;
37
38			public function __construct(
39			EntityManagerInterface $entityManager,
40			ArticleRepositoryInterface $articleRepository
41			) {
42			parent::__construct();
43
44			$this->entityManager = $entityManager;
45			$this->articleRepository = $articleRepository;
46			}
47
48			protected function configure(): void
49			{
50			$this
51			->setName(self::$defaultName)
52			->setDescription('Remove from article body missing embedded images')
53			->addOption('dry-run', null, InputOption::VALUE_NONE, 'Do not execute anything, just show what was found')
54			->addOption('limit', null, InputOption::VALUE_REQUIRED, 'Limit for searched articles')
55			->addArgument('term', InputArgument::REQUIRED, 'Article body fragment')
56			->addArgument('parent', InputArgument::REQUIRED, 'Found element parent to be removed');
57			}
58
59			protected function execute(InputInterface $input, OutputInterface $output): int
60			{
61			$limit = 2000;
62			if (null !== $input->getOption('limit')) {
63			$limit = (int) $input->getOption('limit');
64			}
65			/** @var ArticleInterface[] $brokenArticles */
66			$brokenArticles = $this->getArticlesByBodyContent($this->entityManager, $input->getArgument('term'), $limit);
			0 ignored issues – show Bug introduced 2020-03-27 08:08 UTC by Report Bug Copy Issue Report It seems like `$input->getArgument('term')` targeting `Symfony\Component\Consol...nterface::getArgument()` can also be of type `array<integer,string>` or `null`; however, `SWP\Bundle\CoreBundle\Co...ArticlesByBodyContent()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
67			foreach ($brokenArticles as $article) {
68			$output->writeln(sprintf('Cleaning article: %s', $article->getTitle()));
69			$articleBody = $article->getBody();
70			$crawler = new Crawler($articleBody);
71			$crawler->filter('img')
72			->reduce(function (Crawler $node, $i) use ($input) {
			0 ignored issues – show Unused Code introduced 2020-03-24 15:31 UTC by Report Bug Copy Issue Report The parameter `$i` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
73			if (false === strpos($node->attr('src'), $input->getArgument('term'))) {
74			return false;
75			}
76			})
77			->each(static function (Crawler $crawler, $i) use ($input) {
			0 ignored issues – show Unused Code introduced 2020-03-24 15:31 UTC by Report Bug Copy Issue Report The parameter `$i` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
78			$closest = $crawler->closest($input->getArgument('parent'));
			0 ignored issues – show Bug introduced 2020-03-27 08:08 UTC by Report Bug Copy Issue Report It seems like `$input->getArgument('parent')` targeting `Symfony\Component\Consol...nterface::getArgument()` can also be of type `array<integer,string>` or `null`; however, `Symfony\Component\DomCrawler\Crawler::closest()` does only seem to accept `string`, maybe add an additional type check? This check looks at variables that are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
79			if (is_iterable($closest)) {
80			foreach ($closest as $node) {
			0 ignored issues – show Bug introduced 2020-03-27 08:08 UTC by Report Bug Copy Issue Report The expression `$closest` of type `object<Symfony\Component\DomCrawler\Crawler>\|null` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
81			$node->parentNode->removeChild($node);
82			}
83			}
84			});
85
86			$newContent = $crawler->filter('html body')->each(static function (Crawler $crawler) {
87			return $crawler->html();
88			});
89
90			$article->setBody(implode('', $newContent));
91			}
92
93			if (true !== $input->getOption('dry-run')) {
94			$this->entityManager->flush();
95			}
96
97			$output->writeln('<bg=green;options=bold>Done. In total processed '.\count($brokenArticles).' articles.</>');
98
99			return 0;
100			}
101
102			private function getArticlesByBodyContent(EntityManagerInterface $manager, string $content, int $limit): array
103			{
104			$queryBuilder = $manager->createQueryBuilder();
105			$queryBuilder->select('a')->from(Article::class, 'a');
106			$like = $queryBuilder->expr()->like('a.body', $queryBuilder->expr()->literal('%'.$content.'%'));
107			$queryBuilder->andWhere($like);
108			$queryBuilder->setMaxResults($limit);
109
110			return $queryBuilder->getQuery()->getResult();
111			}
112			}
113

superdesk / web-publisher

Push — 2.1 ( 236a62...b86345 )

getArticlesByBodyContent() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like