Add ProgressScanner to manage progress of scan jobs

Author: nochso

src/PHPSemVerChecker/Console/Command/CompareCommand.php

@@ -9,9 +9,9 @@
 use PHPSemVerChecker\Finder\Finder;
 use PHPSemVerChecker\Reporter\JsonReporter;
 use PHPSemVerChecker\Reporter\Reporter;
+use PHPSemVerChecker\Scanner\ProgressScanner;
 use PHPSemVerChecker\Scanner\Scanner;
 use Symfony\Component\Console\Command\Command;
-use Symfony\Component\Console\Helper\ProgressBar;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
@@ -64,22 +64,10 @@ protected function execute(InputInterface $input, OutputInterface $output)
 		$sourceFilter = new SourceFilter();
 		$identicalCount = $sourceFilter->filter($sourceBefore, $sourceAfter);
 
-		$progress = new ProgressBar($output, count($sourceBefore) + count($sourceAfter));
-		$progress->setFormat("%message%\n%current%/%max% [%bar%] %percent:3s%% %elapsed:6s%/%estimated:-6s% %memory:6s%");
-		$output->writeln('');
-		$progress->setMessage('Scanning before files');
-		foreach ($sourceBefore as $file) {
-			$scannerBefore->scan($file);
-			$progress->advance();
-		}
-
-		$progress->setMessage('Scanning after files');
-		foreach ($sourceAfter as $file) {
-			$scannerAfter->scan($file);
-			$progress->advance();
-		}
-
-		$progress->clear();
+		$progress = new ProgressScanner($output);
+		$progress->addJob($input->getArgument('source-before'), $sourceBefore, $scannerBefore);
+		$progress->addJob($input->getArgument('source-after'), $sourceAfter, $scannerAfter);
+		$progress->runJobs();
 
 		$registryBefore = $scannerBefore->getRegistry();
 		$registryAfter = $scannerAfter->getRegistry();

src/PHPSemVerChecker/Scanner/ProgressScanner.php

@@ -0,0 +1,98 @@
+<?php
+
+namespace PHPSemVerChecker\Scanner;
+
+use Symfony\Component\Console\Helper\ProgressBar;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * ProgressScanner helps run and display the progress of a scan job.
+ */
+class ProgressScanner
+{
+	/**
+	 * @var string[][]
+	 */
+	private $fileLists = [];
+	/**
+	 * @var \PHPSemVerChecker\Scanner\Scanner[]
+	 */
+	private $scanners = [];
+	/**
+	 * @var \Symfony\Component\Console\Output\OutputInterface
+	 */
+	private $output;
+	/**
+	 * @var \Symfony\Component\Console\Helper\ProgressBar
+	 */
+	private $progressBar;
+
+	/**
+	 * @param \Symfony\Component\Console\Output\OutputInterface $output
+	 */
+	public function __construct(OutputInterface $output)
+	{
+		$this->output = $output;
+	}
+
+	/**
+	 * @param string $name
+	 * @param string[] $fileList
+	 * @param \PHPSemVerChecker\Scanner\Scanner $scanner
+	 */
+	public function addJob($name, $fileList, $scanner)
+	{
+		$this->fileLists[$name] = $fileList;
+		$this->scanners[$name] = $scanner;
+	}
+
+	/**
+	 * Run all registered jobs.
+	 */
+	public function runJobs()
+	{
+		foreach (array_keys($this->scanners) as $jobName) {
+			$this->runJob($jobName);
+		}
+	}
+
+	/**
+	 * Run a single job.
+	 *
+	 * @param string $jobName
+	 */
+	public function runJob($jobName)
+	{
+		$progress = $this->getProgressBar();
+		$progress->setMessage('Scanning ' . $jobName);
+		$scanner = $this->scanners[$jobName];
+		foreach ($this->fileLists[$jobName] as $filePath) {
+			$scanner->scan($filePath);
+			$progress->advance();
+		}
+		if ($progress->getProgress() === $progress->getMaxSteps()) {
+			$progress->clear();
+		}
+	}
+
+	/**
+	 * @return int
+	 */
+	private function getFileCount()
+	{
+		return array_sum(array_map('count', $this->fileLists));
+	}
+
+	/**
+	 * @return \Symfony\Component\Console\Helper\ProgressBar
+	 */
+	private function getProgressBar()
+	{
+		if ($this->progressBar === null) {
+			$this->progressBar = new ProgressBar($this->output, $this->getFileCount());
+			$this->progressBar->setFormat("%message%\n%current%/%max% [%bar%] %percent:3s%% %elapsed:6s%/%estimated:-6s% %memory:6s%");
+			$this->output->writeln('');
+		}
+		return $this->progressBar;
+	}
+}