tweak FileStreamWrapper behavior & small comment + use statements tweaks

Author: bkdotcom

src/Debug/LogEntry.php

@@ -153,7 +153,7 @@ public function getChannelName()
     }
 
     /**
-     * Get meta value
+     * Get meta value(s)
      *
      * @param string $key     key to get
      *                        if not passed, return all meta values (no different than $logEntry['meta'])

src/Debug/Plugin/Method/Basic.php

@@ -56,8 +56,8 @@ class Basic implements SubscriberInterface
      *
      * @return Debug
      *
-     * 2.0 Default message used if none passed
-     * 2.3 Support for substitution & formatting
+     * @since 2.0 Default message used if none passed
+     * @since 2.3 Support for substitution & formatting
      */
     public function assert($assertion, $msg = null)
     {

src/Debug/Utility/FileStreamWrapperBase.php

@@ -27,7 +27,7 @@ class FileStreamWrapperBase
     /** @var string */
     const OUTPUT_DESTINATION = 'php://memory';
     /** @var int */
-    const STREAM_OPEN_FOR_INCLUDE = 128;
+    const STREAM_OPEN_FOR_INCLUDE = 128; // STREAM_REPORT_ERRORS
 
     /** @var resource|null The current context, or null if no context was passed to the caller function */
     public $context;
@@ -275,6 +275,6 @@ private static function registerProtocol($protocol)
     protected static function shouldTransform($file, $options)
     {
         $including = (bool) ($options & static::STREAM_OPEN_FOR_INCLUDE);
-        return $including && static::isTargeted($file);
+        return static::isTargeted($file) && ($including || \in_array($file, self::$filesTransformed, true));
     }
 }

src/Debug/Utility/Php.php

@@ -10,6 +10,7 @@
 
 namespace bdk\Debug\Utility;
 
+use bdk\Debug\Utility\PhpType;
 use bdk\Debug\Utility\Reflection;
 
 /**
@@ -60,7 +61,7 @@ public static function friendlyClassName($mixed)
         if ($reflector && \method_exists($reflector, 'getDeclaringClass')) {
             $reflector = $reflector->getDeclaringClass();
         }
-        return \bdk\Debug\Utility\PhpType::getDebugTypeObject($reflector->getName());
+        return PhpType::getDebugTypeObject($reflector->getName());
     }
 
     /**
@@ -78,7 +79,7 @@ public static function friendlyClassName($mixed)
      */
     public static function getDebugType($val)
     {
-        return \bdk\Debug\Utility\PhpType::getDebugType($val);
+        return PhpType::getDebugType($val);
     }
 
     /**
@@ -130,7 +131,7 @@ public static function getIniFiles()
      */
     public static function isCallable($val, $opts = 0)
     {
-        return \bdk\Debug\Utility\PhpType::isCallable($val, $opts);
+        return PhpType::isCallable($val, $opts);
     }
 
     /**
@@ -142,7 +143,7 @@ public static function isCallable($val, $opts = 0)
      */
     public static function isThrowable($val)
     {
-        return \bdk\Debug\Utility\PhpType::isThrowable($val);
+        return PhpType::isThrowable($val);
     }
 
     /**

src/Debug/Utility/PhpType.php

@@ -16,7 +16,7 @@
 use UnitEnum;
 
 /**
- * Php language utilities
+ * Php type utilities
  */
 class PhpType
 {
@@ -65,14 +65,16 @@ public static function assertType($value, $type, $paramName = null, $frameOffset
      *  - 'callable' for callable array
      *  - enum name for enum value
      *
-     * @param mixed $val The value being type checked
+     * @param mixed $val      The value being type checked
+     * @param bool  $isObject Set to true if value is an object (but not Closure or UnitEnum)
      *
      * @return string
      *
      * @see https://github.com/symfony/polyfill/blob/main/src/Php80/Php80.php
      */
-    public static function getDebugType($val)
+    public static function getDebugType($val, &$isObject = false)
     {
+        $isObject = false;
         $type = \strtr(\strtolower(\gettype($val)), array(
             'boolean' => 'bool',
             'double' => 'float',
@@ -92,6 +94,7 @@ public static function getDebugType($val)
             case $val instanceof \__PHP_Incomplete_Class:
                 return '__PHP_Incomplete_Class';
             case $type === 'object':
+                $isObject = $val instanceof UnitEnum === false && $val instanceof \Closure === false;
                 return self::getDebugTypeObject($val);
             default:
                 return self::getDebugTypeResource($val);
@@ -101,7 +104,7 @@ public static function getDebugType($val)
     /**
      * Get friendly class name
      *
-     * @param object $obj Object to inspect
+     * @param object|class-string $obj Object to inspect
      *
      * @return string
      */

src/Debug/Utility/Sql.php

@@ -91,6 +91,7 @@ public static function parse($sql)
                 DELETE.*?FROM\s+\S+|
                 INSERT(?:\s+(?:LOW_PRIORITY|DELAYED|HIGH_PRIORITY|IGNORE|INTO))*\s+\S+|
                 SELECT\s+(?P<select>.*?)\s+FROM\s+(?<from>\S+)|
+                SET\s+.+|
                 UPDATE\s+\S+
             )
             (?P<afterMethod>.*?)

tests/Backtrace/ContextTest.php

@@ -4,6 +4,7 @@
 
 use bdk\Backtrace;
 use bdk\Backtrace\Normalizer;
+use bdk\PhpUnitPolyfill\AssertionTrait;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -14,6 +15,8 @@
  */
 class ContextTest extends TestCase
 {
+    use AssertionTrait;
+
     public function testAddContext()
     {
         $line1 = __LINE__ + 2;
@@ -93,8 +96,8 @@ public function testAddContextXdebug()
     public function testGetFileLines()
     {
         self::assertFalse(Backtrace::getFileLines('/no/such/file.php'));
-        self::assertSame(array(
-            1 => "<?php\n",
-        ), Backtrace::getFileLines(__FILE__, 0, 1));
+        $lines = Backtrace::getFileLines(__FILE__, 0, 1);
+        self::assertCount(1, $lines);
+        self::assertMatchesRegularExpression('/<\?php( declare\(ticks=1\);)?\n/', \implode("\n", $lines));
     }
 }