Merge aec8102 into 6e52303

.php_cs.dist

@@ -27,6 +27,8 @@ return PhpCsFixer\Config::create()
         'native_function_invocation' => true,
         'header_comment' => array('header' => $header),
         'phpdoc_align' => true,
+        'phpdoc_order' => true,
+        'phpdoc_types_order' => true,
     ))
     ->setFinder($finder)
 ;

.travis.yml

@@ -84,8 +84,8 @@ before_script:
 
 script:
   - if [[ "$RUN_CS_FIXER" = "true" ]]; then php -n ${PHP_CS_FIXER} --diff --dry-run -v --allow-risky=yes fix; fi
-  - php ${PHP_ARGS} vendor/bin/phpunit ${PHPUNIT_EXCLUDE}
-  - MODE_SPEED_TEST=true php ${PHP_ARGS} vendor/bin/phpunit ${PHPUNIT_EXCLUDE}
+  - php ${PHP_ARGS} vendor/bin/phpunit ${PHPUNIT_EXCLUDE} -v
+  - MODE_SPEED_TEST=true php ${PHP_ARGS} vendor/bin/phpunit ${PHPUNIT_EXCLUDE} -v
   - |
     if [[ ${TRAVIS_PHP_VERSION:0:3} == "7.1" ]]; then
       wget https://github.com/infection/infection/releases/download/0.10.3/infection.phar;
@@ -97,10 +97,14 @@ script:
     fi
   - php examples/big-dump.php
   - php examples/binary-string.php
+  - php examples/closure.php
   - php examples/custom-indent.php
   - php examples/debug-info.php
   - php examples/dumper.php
+  - php examples/exception.php
+  - php examples/pre-exception-variadic.php
   - php examples/object.php
+  - php examples/simple-array.php
 
 after_script:
   - mv ~.git .git

examples/closure.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of the awesomite/var-dumper package.
+ *
+ * (c) Bartłomiej Krukowski <bartlomiej@krukowski.me>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Awesomite\VarDumper\LightVarDumper;
+
+require __DIR__ . DIRECTORY_SEPARATOR . 'init.php';
+
+global $argc, $argv;
+$function = function ($a, $b) use ($argc, $argv) {
+};
+
+$dumper = new LightVarDumper();
+$dumper->dump($function);
+
+/*
+
+Output:
+
+object(Closure) #3 {[
+        $name =>      “{closure}”
+        $filename =>  “(...)/examples/closure.php”
+        $startLine => 17
+        $endLine =>   18
+        $use =>
+            array(2) {
+                [argc] => 1
+                [argv] => array(1) {“examples/closure.php”}
+            }
+]}
+
+*/

examples/exception-variadic.php

@@ -0,0 +1,77 @@
+<?php
+
+/*
+ * This file is part of the awesomite/var-dumper package.
+ *
+ * (c) Bartłomiej Krukowski <bartlomiej@krukowski.me>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Awesomite\VarDumper\LightVarDumper;
+
+require __DIR__ . DIRECTORY_SEPARATOR . 'init.php';
+
+/**
+ * @internal
+ */
+class DivideByZeroException extends \Exception
+{
+}
+
+/**
+ * @internal
+ */
+class Divider
+{
+    public function divide($a, $b)
+    {
+        if (0 === $b) {
+            throw new DivideByZeroException('Cannot divide by zero');
+        }
+
+        return $a/$b;
+    }
+}
+
+/**
+ * @internal
+ */
+class Controller
+{
+    public static function execute($class, $method, ...$params)
+    {
+        (new $class())->$method(...$params);
+    }
+}
+
+try {
+    Controller::execute(Divider::class, 'divide', 10, 0);
+} catch (\Exception $exception) {
+    $dumper = new LightVarDumper();
+    $dumper->dump($exception);
+}
+
+/*
+
+Output:
+
+object(DivideByZeroException) #2 {[
+    [message] =>  “Cannot divide by zero”
+    [code] =>     0
+    [file] =>     “(...)/examples/exception-variadic.php:31”
+    [previous] => NULL
+    [trace] =>
+        1. (...)/examples/exception-variadic.php:45 Divider->divide(
+            a: 10
+            b: 0
+        )
+        2. (...)/examples/exception-variadic.php:50 Controller::execute(
+            class:  “Divider”
+            method: “divide”
+            params: array(2) {10, 0}
+        )
+]}
+
+*/

examples/exception.php

@@ -0,0 +1,82 @@
+<?php
+
+/*
+ * This file is part of the awesomite/var-dumper package.
+ *
+ * (c) Bartłomiej Krukowski <bartlomiej@krukowski.me>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+use Awesomite\VarDumper\LightVarDumper;
+
+require __DIR__ . DIRECTORY_SEPARATOR . 'init.php';
+
+/**
+ * @internal
+ */
+class DivideByZeroException extends \Exception
+{
+}
+
+/**
+ * @internal
+ */
+class Divider
+{
+    public function divide($a, $b)
+    {
+        if (0 === $b) {
+            throw new DivideByZeroException('Cannot divide by zero');
+        }
+
+        return $a/$b;
+    }
+}
+
+/**
+ * @internal
+ */
+class Calculator
+{
+    public static function execute($action, $numberA, $numberB)
+    {
+        if ('divide' == $action) {
+            $divider = new Divider();
+
+            return $divider->divide($numberA, $numberB);
+        }
+    }
+}
+
+try {
+    $calculator = new Calculator();
+    $calculator->execute('divide', 5, 0);
+} catch (\Exception $exception) {
+    $dumper = new LightVarDumper();
+    $dumper->dump($exception);
+}
+
+/*
+
+Output:
+
+object(DivideByZeroException) #4 {[
+    [message] =>  “Cannot divide by zero”
+    [code] =>     0
+    [file] =>     “(...)/examples/exception.php:31”
+    [previous] => NULL
+    [trace] =>
+        1. (...)/examples/exception.php:48 Divider->divide(
+            a: 5
+            b: 0
+        )
+        2. (...)/examples/exception.php:55 Calculator::execute(
+            action:  “divide”
+            numberA: 5
+            numberB: 0
+        )
+]}
+
+*/

examples/pre-exception-variadic.php

@@ -0,0 +1,16 @@
+<?php
+
+/*
+ * This file is part of the awesomite/var-dumper package.
+ *
+ * (c) Bartłomiej Krukowski <bartlomiej@krukowski.me>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+if (\version_compare(PHP_VERSION, '5.6') >= 0) {
+    require_once __DIR__ . DIRECTORY_SEPARATOR . 'exception-variadic.php';
+} else {
+    echo "PHP >= 5.6 required\n";
+}

src/Config/AbstractConfig.php

@@ -14,7 +14,7 @@
 /**
  * @internal
  */
-class AbstractConfig
+abstract class AbstractConfig
 {
     protected $maxChildren;
 

src/Helpers/Container.php

@@ -12,9 +12,9 @@
 namespace Awesomite\VarDumper\Helpers;
 
 use Awesomite\VarDumper\Config\AbstractConfig;
-use Awesomite\VarDumper\LightVarDumper;
 use Awesomite\VarDumper\Objects\HasherFactory;
 use Awesomite\VarDumper\Objects\HasherInterface;
+use Awesomite\VarDumper\Subdumpers\SubdumpersCollection;
 
 /**
  * @internal
@@ -27,13 +27,11 @@ final class Container
 
     private $config;
 
-    private $printNlOnEnd;
-
     private $dumper;
 
     private static $hasher;
 
-    public function __construct(AbstractConfig $config, LightVarDumper $dumper)
+    public function __construct(AbstractConfig $config, SubdumpersCollection $dumper)
     {
         $this->config = $config;
         $this->dumper = $dumper;
@@ -64,15 +62,7 @@ public function getDepth()
     }
 
     /**
-     * @return BoolValue
-     */
-    public function getPrintNlOnEnd()
-    {
-        return $this->printNlOnEnd ?: $this->printNlOnEnd = new BoolValue(true);
-    }
-
-    /**
-     * @return LightVarDumper
+     * @return SubdumpersCollection
      */
     public function getDumper()
     {

src/Helpers/FileNameDecorator.php

@@ -0,0 +1,48 @@
+<?php
+
+/*
+ * This file is part of the awesomite/var-dumper package.
+ *
+ * (c) Bartłomiej Krukowski <bartlomiej@krukowski.me>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Awesomite\VarDumper\Helpers;
+
+/**
+ * @internal
+ */
+final class FileNameDecorator
+{
+    const MAX_FILE_NAME_DEPTH = 3;
+
+    /**
+     * @param string   $fileName
+     * @param null|int $maxDepth
+     *
+     * @return string
+     */
+    public static function decorateFileName($fileName, $maxDepth = null)
+    {
+        $maxDepth = \is_null($maxDepth)
+            ? static::MAX_FILE_NAME_DEPTH
+            : $maxDepth;
+
+        $relativeTo = $fileName;
+        for ($i = 0; $i < $maxDepth; $i++) {
+            $relativeTo = \dirname($relativeTo);
+        }
+
+        if ($relativeTo === $fileName) {
+            return $fileName;
+        }
+
+        $exploded = \explode(DIRECTORY_SEPARATOR, $fileName);
+        $newParts = \array_slice($exploded, -$maxDepth, $maxDepth);
+        \array_unshift($newParts, '(...)');
+
+        return \implode(DIRECTORY_SEPARATOR, $newParts);
+    }
+}

src/Helpers/KeyValuePrinter.php

@@ -11,6 +11,10 @@
 
 namespace Awesomite\VarDumper\Helpers;
 
+use Awesomite\VarDumper\Strings\LinePart;
+use Awesomite\VarDumper\Strings\PartInterface;
+use Awesomite\VarDumper\Strings\Parts;
+
 /**
  * @internal
  */
@@ -33,13 +37,24 @@ public function add($key, $value, $strlen)
         $this->rows[] = array($key, $value, $strlen);
     }
 
+    /**
+     * @return null|PartInterface
+     */
     public function flush()
     {
+        if (!$this->rows) {
+            return null;
+        }
+
+        $result = new Parts();
         foreach ($this->rows as $data) {
             list($key, $value, $strlen) = $data;
-            echo $key, \str_pad('', $this->maxLength - $strlen, ' '), $value, "\n";
+            $part = new LinePart($key . \str_pad('', $this->maxLength - $strlen, ' ') . $value);
+            $result->appendPart($part);
         }
         $this->rows = array();
         $this->maxLength = 0;
+
+        return $result;
     }
 }