CLI writes on STDERR

Author: Slamdunk

composer.json

@@ -13,6 +13,9 @@
     "autoload": {
         "files": ["lib/r.php"]
     },
+    "autoload-dev": {
+        "classmap": ["tests/"]
+    },
     "require": {
         "php": "^7.1"
     },

lib/r.php

@@ -6,13 +6,13 @@
 {
     use Slam\Debug\R as DebugR;
 
-    function r($var, bool $exit = true, int $level = 0, bool $fullstack = false)
+    function r($var, bool $exit = true, int $level = 0, bool $fullstack = false): void
     {
         DebugR::$db = \debug_backtrace();
         DebugR::debug($var, $exit, $level, $fullstack);
     }
 
-    function rq(string $query, array $params, bool $exit = true, int $level = 0, bool $fullstack = false)
+    function rq(string $query, array $params, bool $exit = true, int $level = 0, bool $fullstack = false): void
     {
         \uksort($params, function (string $key1, string $key2) {
             return \strlen($key2) <=> \strlen($key1);
@@ -37,13 +37,13 @@ function rq(string $query, array $params, bool $exit = true, int $level = 0, boo
 
     final class R
     {
-        public static $db = array();
+        public static $db = [];
 
         private function __construct()
         {
         }
 
-        public static function debug($var, bool $exit = true, int $level = 0, bool $fullstack = false)
+        public static function debug($var, bool $exit = true, int $level = 0, bool $fullstack = false): void
         {
             if (null === $var or \is_scalar($var)) {
                 \ob_start();
@@ -56,7 +56,7 @@ public static function debug($var, bool $exit = true, int $level = 0, bool $full
             }
 
             if (\PHP_SAPI === 'cli') {
-                echo \PHP_EOL . self::formatDb($fullstack) . $output . \PHP_EOL;
+                \fwrite(\STDERR, \PHP_EOL . self::formatDb($fullstack) . $output . \PHP_EOL);
             } else {
                 echo '<pre><strong>' . self::formatDb($fullstack) . '</strong><br />' . \htmlspecialchars($output) . '</pre>';
             }
@@ -77,7 +77,7 @@ private static function formatDb(bool $fullstack): string
 
                 $output .= (isset($point['class']) ? $point['class'] . '->' : '') . $point['function'];
 
-                $args = array();
+                $args = [];
                 foreach ($point['args'] as $argument) {
                     $args[] = (\is_object($argument)
                         ? \get_class($argument)

tests/MockStderr.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SlamTest\Debug;
+
+use php_user_filter;
+
+final class MockStderr extends php_user_filter
+{
+    public static $output = '';
+
+    public function filter($in, $out, & $consumed, $closing)
+    {
+        while ($bucket = \stream_bucket_make_writeable($in)) {
+            self::$output = $bucket->data;
+            $consumed += $bucket->datalen;
+        }
+
+        return \PSFS_PASS_ON;
+    }
+}

tests/RTest.php

@@ -9,65 +9,74 @@
 
 final class RTest extends TestCase
 {
+    const STREAM_FILTER_NAME = 'STDERR_MOCK';
+
+    private static $isStreamFilterRegistered;
+
+    private $registeredFilter;
+
+    protected function setUp()
+    {
+        if (true !== self::$isStreamFilterRegistered) {
+            self::$isStreamFilterRegistered = \stream_filter_register(self::STREAM_FILTER_NAME, MockStderr::class);
+        }
+
+        MockStderr::$output     = '';
+        $this->registeredFilter = \stream_filter_prepend(\STDERR, self::STREAM_FILTER_NAME, \STREAM_FILTER_WRITE);
+    }
+
+    protected function tearDown()
+    {
+        \stream_filter_remove($this->registeredFilter);
+    }
+
     public function testScalar()
     {
-        \ob_start();
         r(1, false);
-        $output = \ob_get_clean();
 
-        $this->assertContains(__FILE__, $output);
-        $this->assertContains('int(1)', $output);
+        $this->assertContains(__FILE__, MockStderr::$output);
+        $this->assertContains('int(1)', MockStderr::$output);
     }
 
     public function testNonScalar()
     {
-        \ob_start();
-        r(array(1 => 2), false);
-        $output = \ob_get_clean();
+        r([1 => 2], false);
 
-        $this->assertContains(__FILE__, $output);
-        $this->assertContains("Array\n(\n    [1] => 2\n)", $output);
+        $this->assertContains(__FILE__, MockStderr::$output);
+        $this->assertContains("Array\n(\n    [1] => 2\n)", MockStderr::$output);
     }
 
     public function testFullstackOutput()
     {
-        \ob_start();
         r(1, false, 0, true);
-        $output = \ob_get_clean();
 
-        $this->assertContains(__FILE__, $output);
-        $this->assertContains(__FUNCTION__, $output);
-        $this->assertContains('TestCase', $output);
+        $this->assertContains(__FILE__, MockStderr::$output);
+        $this->assertContains(__FUNCTION__, MockStderr::$output);
+        $this->assertContains('TestCase', MockStderr::$output);
     }
 
     public function testQueryDebug()
     {
-        \ob_start();
-        rq('SELECT * FROM table WHERE c1 = :p1 AND c1 = :p11 AND c1 = :p2', array('p1' => 1, 'p11' => 2, 'p2' => '"'), false, 0, true);
-        $output = \ob_get_clean();
+        rq('SELECT * FROM table WHERE c1 = :p1 AND c1 = :p11 AND c1 = :p2', ['p1' => 1, 'p11' => 2, 'p2' => '"'], false, 0, true);
 
-        $this->assertContains('SELECT * FROM table WHERE c1 = "1" AND c1 = "2" AND c1 = "\\""', $output);
+        $this->assertContains('SELECT * FROM table WHERE c1 = "1" AND c1 = "2" AND c1 = "\\""', MockStderr::$output);
     }
 
     public function testDoctrine()
     {
-        \ob_start();
         r(new stdClass(), false, 1);
-        $output = \ob_get_clean();
 
-        $this->assertContains(__FILE__, $output);
-        $this->assertContains('__CLASS__', $output);
+        $this->assertContains(__FILE__, MockStderr::$output);
+        $this->assertContains('__CLASS__', MockStderr::$output);
     }
 
     public function testClearRootPath()
     {
         \define('ROOT_PATH', __DIR__);
 
-        \ob_start();
         r(1, false);
-        $output = \ob_get_clean();
 
-        $this->assertContains(\basename(__FILE__), $output);
-        $this->assertNotContains(__DIR__, $output);
+        $this->assertContains(\basename(__FILE__), MockStderr::$output);
+        $this->assertNotContains(__DIR__, MockStderr::$output);
     }
 }