Merge pull request #19 from jeroenvermeulen/result_output_improved

Result output improved

Author: philipnorton42

src/Command/SitemapChecker.php

@@ -204,44 +204,27 @@ protected function execute(InputInterface $input, OutputInterface $output):int
         }
 
         $progressBar->finish();
+        // We don't want to print our next output after the progress bar.
+        $output->writeln('');
 
         $resultFile = $input->getOption('result-file');
 
         if ($resultFile === NULL) {
-          // Write a blank line to print the results correctly.
           $resultRender = new PlainResultRender();
-          $output->writeln('');
           $output->writeln($resultRender->render($results));
         }
-        elseif (is_string($resultFile) && str_contains($resultFile, '.csv')) {
-          $io->info('Writing CSV file.');
-          $resultRender = new CsvResultRender();
-          $renderedResult = $resultRender->render($results);
-          file_put_contents($resultFile, $renderedResult);
-        }
-        elseif (is_string($resultFile) && str_contains($resultFile, '.json')) {
-          $io->info('Writing JSON file.');
-          $resultRender = new JsonResultRender();
-          $renderedResult = $resultRender->render($results);
-          file_put_contents($resultFile, $renderedResult);
-        }
-        elseif (is_string($resultFile) && str_contains($resultFile, '.xml')) {
-          $io->info('Writing XML file.');
-          $resultRender = new XmlResultRender();
-          $renderedResult = $resultRender->render($results);
-          file_put_contents($resultFile, $renderedResult);
-        }
-        elseif (is_string($resultFile) && str_contains($resultFile, '.html')) {
-          $io->info('Writing HTML file.');
-          $resultRender = new HtmlResultRender();
-          $renderedResult = $resultRender->render($results);
-          file_put_contents($resultFile, $renderedResult);
-        }
         else {
-          $io->error('Invalid output format found.');
-          return Command::INVALID;
+            $resultExt = strtolower(pathinfo($resultFile, PATHINFO_EXTENSION));
+            $resultRender = match ($resultExt) {
+              'csv' => new CsvResultRender(),
+              'json' => new JsonResultRender(),
+              'xml' => new XmlResultRender(),
+              'html' => new HtmlResultRender(),
+              default => new PlainResultRender(),
+            };
+            $io->info(sprintf('Writing %s file.', $resultRender->getType()));
+            file_put_contents($resultFile, $resultRender->render($results));
         }
-
         return Command::SUCCESS;
     }
 

src/ResultRender/CsvResultRender.php

@@ -20,5 +20,9 @@ public function render(ResultCollectionInterface $resultCollection): string
     return $string;
   }
 
+  public function getType(): string
+  {
+    return 'CSV';
+  }
 
 }

src/ResultRender/HtmlResultRender.php

@@ -36,5 +36,9 @@ public function render(ResultCollectionInterface $resultCollection): string
 EOL;
   }
 
+  public function getType(): string
+  {
+    return 'HTML';
+  }
 
 }

src/ResultRender/JsonResultRender.php

@@ -23,5 +23,9 @@ public function render(ResultCollectionInterface $resultCollection): string
     return json_encode($array, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES | JSON_NUMERIC_CHECK) ?: '';
   }
 
+  public function getType(): string
+  {
+    return 'JSON';
+  }
 
 }

src/ResultRender/PlainResultRender.php

@@ -15,5 +15,9 @@ public function render(ResultCollectionInterface $resultCollection): string
     return $string;
   }
 
+  public function getType(): string
+  {
+    return 'plain';
+  }
 
 }

src/ResultRender/ResultRenderInterface.php

@@ -6,4 +6,5 @@
 
 interface ResultRenderInterface {
   public function render(ResultCollectionInterface $resultCollection): string;
+  public function getType(): string;
 }

src/ResultRender/XmlResultRender.php

@@ -22,5 +22,9 @@ public function render(ResultCollectionInterface $resultCollection): string
     return $xml->asXML() ?: '';
   }
 
+  public function getType(): string
+  {
+    return 'XML';
+  }
 
 }

tests/ResultRenderer/CsvResultRendererTest.php

@@ -13,4 +13,10 @@ public function testCsvRenderPrintsResultCorrectly()
     $this->assertStringContainsString('"https://www.example.com/","Title","200"', $renderedResult);
   }
 
+  public function testCsvRenderReturnsType()
+  {
+    $resultRenderer = new CsvResultRender();
+    $this->assertEquals('CSV', $resultRenderer->getType());
+  }
+
 }

tests/ResultRenderer/HtmlResultRendererTest.php

@@ -17,4 +17,10 @@ public function testHtmlRenderPrintsResultCorrectly()
     $this->assertStringContainsString('<li><strong>Response Code:</strong> 200</li>', $renderedResult);
   }
 
+  public function testHtmlRenderReturnsType()
+  {
+    $resultRenderer = new HtmlResultRender();
+    $this->assertEquals('HTML', $resultRenderer->getType());
+  }
+
 }

tests/ResultRenderer/JsonResultRendererTest.php

@@ -16,4 +16,10 @@ public function testJsonRenderPrintsResultCorrectly()
     $this->assertStringContainsString('"response_code":200', $renderedResult);
   }
 
+  public function testJsonRenderReturnsType()
+  {
+    $resultRenderer = new JsonResultRender();
+    $this->assertEquals('JSON', $resultRenderer->getType());
+  }
+
 }