Merge pull request #6754 from paulbalandan/code-coverage-ignore

Simplify `@codeCoverageIgnore*` tags

Author: paulbalandan

system/Common.php

@@ -145,7 +145,10 @@ function command(string $command)
                 $args[] = stripcslashes($match[1]);
             } else {
                 // @codeCoverageIgnoreStart
-                throw new InvalidArgumentException(sprintf('Unable to parse input near "... %s ...".', substr($command, $cursor, 10)));
+                throw new InvalidArgumentException(sprintf(
+                    'Unable to parse input near "... %s ...".',
+                    substr($command, $cursor, 10)
+                ));
                 // @codeCoverageIgnoreEnd
             }
 
@@ -357,12 +360,10 @@ function db_connect($db = null, bool $getShared = true)
      */
     function dd(...$vars)
     {
-        // @codeCoverageIgnoreStart
         Kint::$aliases[] = 'dd';
         Kint::dump(...$vars);
 
         exit;
-        // @codeCoverageIgnoreEnd
     }
 }
 
@@ -494,18 +495,13 @@ function force_https(int $duration = 31_536_000, ?RequestInterface $request = nu
         }
 
         if ((ENVIRONMENT !== 'testing' && (is_cli() || $request->isSecure())) || (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] === 'test')) {
-            // @codeCoverageIgnoreStart
-            return;
-            // @codeCoverageIgnoreEnd
+            return; // @codeCoverageIgnore
         }
 
         // If the session status is active, we should regenerate
         // the session ID for safety sake.
         if (ENVIRONMENT !== 'testing' && session_status() === PHP_SESSION_ACTIVE) {
-            // @codeCoverageIgnoreStart
-            Services::session(null, true)
-                ->regenerate();
-            // @codeCoverageIgnoreEnd
+            Services::session(null, true)->regenerate(); // @codeCoverageIgnore
         }
 
         $baseURL = config(App::class)->baseURL;
@@ -530,9 +526,7 @@ function force_https(int $duration = 31_536_000, ?RequestInterface $request = nu
         $response->sendHeaders();
 
         if (ENVIRONMENT !== 'testing') {
-            // @codeCoverageIgnoreStart
-            exit();
-            // @codeCoverageIgnoreEnd
+            exit(); // @codeCoverageIgnore
         }
     }
 }
@@ -796,10 +790,7 @@ function log_message(string $level, string $message, array $context = [])
             return $logger->log($level, $message, $context);
         }
 
-        // @codeCoverageIgnoreStart
-        return Services::logger(true)
-            ->log($level, $message, $context);
-        // @codeCoverageIgnoreEnd
+        return Services::logger(true)->log($level, $message, $context); // @codeCoverageIgnore
     }
 }
 
@@ -834,9 +825,7 @@ function old(string $key, $default = null, $escape = 'html')
     {
         // Ensure the session is loaded
         if (session_status() === PHP_SESSION_NONE && ENVIRONMENT !== 'testing') {
-            // @codeCoverageIgnoreStart
-            session();
-            // @codeCoverageIgnoreEnd
+            session(); // @codeCoverageIgnore
         }
 
         $request = Services::request();

system/Format/XMLFormatter.php

@@ -34,10 +34,7 @@ public function format($data)
         // SimpleXML is installed but default
         // but best to check, and then provide a fallback.
         if (! extension_loaded('simplexml')) {
-            // never thrown in travis-ci
-            // @codeCoverageIgnoreStart
-            throw FormatException::forMissingExtension();
-            // @codeCoverageIgnoreEnd
+            throw FormatException::forMissingExtension(); // @codeCoverageIgnore
         }
 
         $options = $config->formatterOptions['application/xml'] ?? 0;

system/Images/Handlers/ImageMagickHandler.php

@@ -41,12 +41,9 @@ public function __construct($config = null)
     {
         parent::__construct($config);
 
-        // We should never see this, so can't test it
-        // @codeCoverageIgnoreStart
         if (! (extension_loaded('imagick') || class_exists(Imagick::class))) {
-            throw ImageException::forMissingExtension('IMAGICK');
+            throw ImageException::forMissingExtension('IMAGICK'); // @codeCoverageIgnore
         }
-        // @codeCoverageIgnoreEnd
     }
 
     /**

system/Test/DOMParser.php

@@ -37,10 +37,7 @@ class DOMParser
     public function __construct()
     {
         if (! extension_loaded('DOM')) {
-            // always there in travis-ci
-            // @codeCoverageIgnoreStart
-            throw new BadMethodCallException('DOM extension is required, but not currently loaded.');
-            // @codeCoverageIgnoreEnd
+            throw new BadMethodCallException('DOM extension is required, but not currently loaded.'); // @codeCoverageIgnore
         }
 
         $this->dom = new DOMDocument('1.0', 'utf-8');

system/Test/FeatureTestCase.php

@@ -159,11 +159,9 @@ public function call(string $method, string $path, ?array $params = null)
 
         // Clean up any open output buffers
         // not relevant to unit testing
-        // @codeCoverageIgnoreStart
         if (\ob_get_level() > 0 && (! isset($this->clean) || $this->clean === true)) {
-            \ob_end_clean();
+            \ob_end_clean(); // @codeCoverageIgnore
         }
-        // @codeCoverageIgnoreEnd
 
         // Simulate having a blank session
         $_SESSION                  = [];
@@ -207,15 +205,13 @@ public function call(string $method, string $path, ?array $params = null)
         Services::router()->setDirectory(null);
 
         // Ensure the output buffer is identical so no tests are risky
-        // @codeCoverageIgnoreStart
         while (\ob_get_level() > $buffer) {
-            \ob_end_clean();
+            \ob_end_clean(); // @codeCoverageIgnore
         }
 
         while (\ob_get_level() < $buffer) {
-            \ob_start();
+            \ob_start(); // @codeCoverageIgnore
         }
-        // @codeCoverageIgnoreEnd
 
         return new FeatureResponse($response);
     }

system/Test/FeatureTestTrait.php

@@ -149,11 +149,9 @@ public function call(string $method, string $path, ?array $params = null)
 
         // Clean up any open output buffers
         // not relevant to unit testing
-        // @codeCoverageIgnoreStart
         if (\ob_get_level() > 0 && (! isset($this->clean) || $this->clean === true)) {
-            \ob_end_clean();
+            \ob_end_clean(); // @codeCoverageIgnore
         }
-        // @codeCoverageIgnoreEnd
 
         // Simulate having a blank session
         $_SESSION                  = [];
@@ -197,15 +195,13 @@ public function call(string $method, string $path, ?array $params = null)
         Services::router()->setDirectory(null);
 
         // Ensure the output buffer is identical so no tests are risky
-        // @codeCoverageIgnoreStart
         while (\ob_get_level() > $buffer) {
-            \ob_end_clean();
+            \ob_end_clean(); // @codeCoverageIgnore
         }
 
         while (\ob_get_level() < $buffer) {
-            \ob_start();
+            \ob_start(); // @codeCoverageIgnore
         }
-        // @codeCoverageIgnoreEnd
 
         return new TestResponse($response);
     }