ScanCommand::configure() - Code Metrics - Inspection of "functionality to add custom options, verify and us..." - spatie/http-status-check - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 828845...d6a05d )

by Freek

created 2017-10-16 19:50 UTC

ScanCommand::configure() A

↳ Parent: ScanCommand

Complexity

Conditions	1
Paths	1

Size

Total Lines	56
Code Lines	45

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	56
rs	9.7251
c	0
b	0
f	0
cc	1
eloc	45
nc	1
nop	0

How to fix Long Method

<?php

namespace Spatie\HttpStatusCheck;

use Spatie\Crawler\Crawler;
use GuzzleHttp\RequestOptions;
use Spatie\Crawler\CrawlAllUrls;
use Spatie\Crawler\CrawlInternalUrls;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Question\ConfirmationQuestion;

class ScanCommand extends Command
{
    protected function configure()
    {
        $this->setName('scan')
            ->setDescription('Check the http status code of all links on a website.')
            ->addArgument(
                'url',
                InputArgument::REQUIRED,
                'The url to check'
            )
            ->addOption(
                'concurrency',
                'c',
                InputOption::VALUE_REQUIRED,
                'The amount of concurrent connections to use',
                10
            )
            ->addOption(
                'output',
                'o',
                InputOption::VALUE_REQUIRED,
                'Log all non-2xx and non-3xx responses in this file'
            )
            ->addOption(
                'dont-crawl-external-links',
                'x',
                InputOption::VALUE_NONE,
                'Dont crawl external links'
            )
            ->addOption(
                'timeout',
                't',
                InputOption::VALUE_OPTIONAL,
                'The maximum number of seconds the request can take',
                10
            )
            ->addOption(
                'user-agent',
                'u',
                InputOption::VALUE_OPTIONAL,
                'The User Agent to pass for the request',
                ''
            )
            ->addOption(
                'skip-verification',
                's',
                InputOption::VALUE_NONE,
                'Skips checking the SSL certificate'
            )
            ->addOption(
                'options',
                'opt',
                InputOption::VALUE_IS_ARRAY | InputOption::VALUE_OPTIONAL,
                'Additional options to the request',
                []
            );
    }

    /**
     * @param \Symfony\Component\Console\Input\InputInterface $input
     * @param \Symfony\Component\Console\Output\OutputInterface $output
     *
     * @return int
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $baseUrl = $input->getArgument('url');
        $crawlProfile = $input->getOption('dont-crawl-external-links') ? new CrawlInternalUrls($baseUrl) : new CrawlAllUrls();

        $output->writeln("Start scanning {$baseUrl}");
        $output->writeln('');

        $crawlLogger = new CrawlLogger($output);

        if ($input->getOption('output')) {
            $outputFile = $input->getOption('output');

            if (file_exists($outputFile)) {
                $helper = $this->getHelper('question');
                $question = new ConfirmationQuestion(
                    "The output file `{$outputFile}` already exists. Overwrite it? (y/n)",
                    false
                );

                if (! $helper->ask($input, $output, $question)) {
                    $output->writeln('Aborting...');

                    return 0;
                }
            }

            $crawlLogger->setOutputFile($input->getOption('output'));
        }

        $clientOptions = [
            RequestOptions::TIMEOUT => $input->getOption('timeout'),
            RequestOptions::VERIFY => ! $input->getOption('skip-verification'),
        ];

        $clientOptions = array_merge($clientOptions, $input->getOption('options'));

        if ($input->getOption('user-agent')) {
            $clientOptions[RequestOptions::HEADERS]['user-agent'] = $input->getOption('user-agent');
        }

        Crawler::create($clientOptions)
            ->setConcurrency($input->getOption('concurrency'))
            ->setCrawlObserver($crawlLogger)
            ->setCrawlProfile($crawlProfile)
            ->startCrawling($baseUrl);

        return 0;
    }
}


1			<?php
2
3			namespace Spatie\HttpStatusCheck;
4
5			use Spatie\Crawler\Crawler;
6			use GuzzleHttp\RequestOptions;
7			use Spatie\Crawler\CrawlAllUrls;
8			use Spatie\Crawler\CrawlInternalUrls;
9			use Symfony\Component\Console\Command\Command;
10			use Symfony\Component\Console\Input\InputOption;
11			use Symfony\Component\Console\Input\InputArgument;
12			use Symfony\Component\Console\Input\InputInterface;
13			use Symfony\Component\Console\Output\OutputInterface;
14			use Symfony\Component\Console\Question\ConfirmationQuestion;
15
16			class ScanCommand extends Command
17			{
18			protected function configure()
19			{
20			$this->setName('scan')
21			->setDescription('Check the http status code of all links on a website.')
22			->addArgument(
23			'url',
24			InputArgument::REQUIRED,
25			'The url to check'
26			)
27			->addOption(
28			'concurrency',
29			'c',
30			InputOption::VALUE_REQUIRED,
31			'The amount of concurrent connections to use',
32			10
33			)
34			->addOption(
35			'output',
36			'o',
37			InputOption::VALUE_REQUIRED,
38			'Log all non-2xx and non-3xx responses in this file'
39			)
40			->addOption(
41			'dont-crawl-external-links',
42			'x',
43			InputOption::VALUE_NONE,
44			'Dont crawl external links'
45			)
46			->addOption(
47			'timeout',
48			't',
49			InputOption::VALUE_OPTIONAL,
50			'The maximum number of seconds the request can take',
51			10
52			)
53			->addOption(
54			'user-agent',
55			'u',
56			InputOption::VALUE_OPTIONAL,
57			'The User Agent to pass for the request',
58			''
59			)
60			->addOption(
61			'skip-verification',
62			's',
63			InputOption::VALUE_NONE,
64			'Skips checking the SSL certificate'
65			)
66			->addOption(
67			'options',
68			'opt',
69			InputOption::VALUE_IS_ARRAY \| InputOption::VALUE_OPTIONAL,
70			'Additional options to the request',
71			[]
72			);
73			}
74
75			/**
76			* @param \Symfony\Component\Console\Input\InputInterface $input
77			* @param \Symfony\Component\Console\Output\OutputInterface $output
78			*
79			* @return int
80			*/
81			protected function execute(InputInterface $input, OutputInterface $output)
82			{
83			$baseUrl = $input->getArgument('url');
84			$crawlProfile = $input->getOption('dont-crawl-external-links') ? new CrawlInternalUrls($baseUrl) : new CrawlAllUrls();
85
86			$output->writeln("Start scanning {$baseUrl}");
87			$output->writeln('');
88
89			$crawlLogger = new CrawlLogger($output);
90
91			if ($input->getOption('output')) {
92			$outputFile = $input->getOption('output');
93
94			if (file_exists($outputFile)) {
95			$helper = $this->getHelper('question');
96			$question = new ConfirmationQuestion(
97			"The output file `{$outputFile}` already exists. Overwrite it? (y/n)",
98			false
99			);
100
101			if (! $helper->ask($input, $output, $question)) {
102			$output->writeln('Aborting...');
103
104			return 0;
105			}
106			}
107
108			$crawlLogger->setOutputFile($input->getOption('output'));
109			}
110
111			$clientOptions = [
112			RequestOptions::TIMEOUT => $input->getOption('timeout'),
113			RequestOptions::VERIFY => ! $input->getOption('skip-verification'),
114			];
115
116			$clientOptions = array_merge($clientOptions, $input->getOption('options'));
117
118			if ($input->getOption('user-agent')) {
119			$clientOptions[RequestOptions::HEADERS]['user-agent'] = $input->getOption('user-agent');
120			}
121
122			Crawler::create($clientOptions)
123			->setConcurrency($input->getOption('concurrency'))
124			->setCrawlObserver($crawlLogger)
125			->setCrawlProfile($crawlProfile)
126			->startCrawling($baseUrl);
127
128			return 0;
129			}
130			}
131

spatie / http-status-check

GitHub Access Token became invalid

Push — master ( 828845...d6a05d )

ScanCommand::configure() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like