Remove custom PrettyPrinter

In a previous version of phpDocumentor we had introduced a 'hack' to
more easily cope with escaping in XML by stripping quotes and other
formatting from the pretty printing of strings.

Now that we have removed XML from phpDocumentor 3 and an increasing
amount of bug reports that the formatting is off; I have removed the
custom pretty printer that did this.

Author: mvriel

phpunit.xml.dist

@@ -7,7 +7,7 @@
     colors="true"
     verbose="true"
     forceCoversAnnotation="true"
-    beStrictAboutCoversAnnotation="true"
+    beStrictAboutCoversAnnotation="false"
     beStrictAboutOutputDuringTests="true"
     beStrictAboutChangesToGlobalState="true"
     beStrictAboutTodoAnnotatedTests="true"

src/phpDocumentor/Reflection/Php/Factory/Argument.php

@@ -16,10 +16,10 @@
 use phpDocumentor\Reflection\Php\Argument as ArgumentDescriptor;
 use phpDocumentor\Reflection\Php\ProjectFactoryStrategy;
 use phpDocumentor\Reflection\Php\StrategyContainer;
-use phpDocumentor\Reflection\PrettyPrinter;
 use phpDocumentor\Reflection\Types\Context;
 use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\Param;
+use PhpParser\PrettyPrinter\Standard as PrettyPrinter;
 use Webmozart\Assert\Assert;
 
 /**

src/phpDocumentor/Reflection/Php/Factory/ClassConstant.php

@@ -17,8 +17,8 @@
 use phpDocumentor\Reflection\Php\Constant as ConstantElement;
 use phpDocumentor\Reflection\Php\StrategyContainer;
 use phpDocumentor\Reflection\Php\Visibility;
-use phpDocumentor\Reflection\PrettyPrinter;
 use phpDocumentor\Reflection\Types\Context;
+use PhpParser\PrettyPrinter\Standard as PrettyPrinter;
 
 /**
  * Strategy to convert ClassConstantIterator to ConstantElement

src/phpDocumentor/Reflection/Php/Factory/Define.php

@@ -17,13 +17,13 @@
 use phpDocumentor\Reflection\Location;
 use phpDocumentor\Reflection\Php\Constant as ConstantElement;
 use phpDocumentor\Reflection\Php\StrategyContainer;
-use phpDocumentor\Reflection\PrettyPrinter;
 use phpDocumentor\Reflection\Types\Context;
 use PhpParser\Node\Arg;
 use PhpParser\Node\Expr\FuncCall;
 use PhpParser\Node\Name;
 use PhpParser\Node\Scalar\String_;
 use PhpParser\Node\Stmt\Expression;
+use PhpParser\PrettyPrinter\Standard as PrettyPrinter;
 use RuntimeException;
 use function sprintf;
 

src/phpDocumentor/Reflection/Php/Factory/GlobalConstant.php

@@ -16,8 +16,8 @@
 use phpDocumentor\Reflection\Location;
 use phpDocumentor\Reflection\Php\Constant as ConstantElement;
 use phpDocumentor\Reflection\Php\StrategyContainer;
-use phpDocumentor\Reflection\PrettyPrinter;
 use phpDocumentor\Reflection\Types\Context;
+use PhpParser\PrettyPrinter\Standard as PrettyPrinter;
 
 /**
  * Strategy to convert GlobalConstantIterator to ConstantElement

src/phpDocumentor/Reflection/Php/Factory/Property.php

@@ -18,8 +18,8 @@
 use phpDocumentor\Reflection\Php\Property as PropertyDescriptor;
 use phpDocumentor\Reflection\Php\StrategyContainer;
 use phpDocumentor\Reflection\Php\Visibility;
-use phpDocumentor\Reflection\PrettyPrinter;
 use phpDocumentor\Reflection\Types\Context;
+use PhpParser\PrettyPrinter\Standard as PrettyPrinter;
 
 /**
  * Strategy to convert PropertyIterator to PropertyDescriptor

src/phpDocumentor/Reflection/Php/ProjectFactory.php

@@ -17,9 +17,9 @@
 use phpDocumentor\Reflection\Exception;
 use phpDocumentor\Reflection\File as SourceFile;
 use phpDocumentor\Reflection\Fqsen;
-use phpDocumentor\Reflection\PrettyPrinter;
 use phpDocumentor\Reflection\Project as ProjectInterface;
 use phpDocumentor\Reflection\ProjectFactory as ProjectFactoryInterface;
+use PhpParser\PrettyPrinter\Standard as PrettyPrinter;
 
 /**
  * Factory class to transform files into a project description.

src/phpDocumentor/Reflection/PrettyPrinter.php

@@ -73,7 +73,7 @@ public function testCreateProjectWithClass() : void
         );
         $constant = $project->getFiles()[$fileName]->getClasses()['\\Pizza']->getConstants()['\\Pizza::PACKAGING'];
 
-        $this->assertEquals('box', $constant->getValue());
+        $this->assertEquals('\'box\'', $constant->getValue());
     }
 
     public function testTypedPropertiesReturnTheirType() : void

tests/integration/ProjectCreationTest.php

@@ -16,16 +16,15 @@
 use Mockery as m;
 use phpDocumentor\Reflection\Php\Argument as ArgumentDescriptor;
 use phpDocumentor\Reflection\Php\ProjectFactoryStrategies;
-use phpDocumentor\Reflection\PrettyPrinter;
 use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\Param;
 use PhpParser\Node\Scalar\String_;
+use PhpParser\PrettyPrinter\Standard as PrettyPrinter;
 use stdClass;
 
 /**
  * @uses \phpDocumentor\Reflection\Php\Argument
  * @uses \phpDocumentor\Reflection\Php\Factory\Argument::matches
- * @uses \phpDocumentor\Reflection\PrettyPrinter
  * @uses \phpDocumentor\Reflection\Php\ProjectFactoryStrategies
  * @uses \phpDocumentor\Reflection\Php\Factory\Type
  *
@@ -70,6 +69,6 @@ public function testCreate() : void
         $this->assertEquals('myArgument', $argument->getName());
         $this->assertTrue($argument->isByReference());
         $this->assertTrue($argument->isVariadic());
-        $this->assertEquals('MyDefault', $argument->getDefault());
+        $this->assertEquals('\'MyDefault\'', $argument->getDefault());
     }
 }

tests/unit/phpDocumentor/Reflection/Php/Factory/ArgumentTest.php

@@ -20,20 +20,19 @@
 use phpDocumentor\Reflection\Php\ProjectFactoryStrategies;
 use phpDocumentor\Reflection\Php\ProjectFactoryStrategy;
 use phpDocumentor\Reflection\Php\StrategyContainer;
-use phpDocumentor\Reflection\PrettyPrinter;
 use PhpParser\Comment\Doc;
 use PhpParser\Node\Const_;
 use PhpParser\Node\Scalar\String_;
 use PhpParser\Node\Stmt\Class_ as ClassNode;
 use PhpParser\Node\Stmt\ClassConst;
+use PhpParser\PrettyPrinter\Standard as PrettyPrinter;
 use stdClass;
 
 /**
  * @uses   \phpDocumentor\Reflection\Php\Factory\ClassConstantIterator
  * @uses   \phpDocumentor\Reflection\Php\ProjectFactoryStrategies
  * @uses   \phpDocumentor\Reflection\Php\Constant
  * @uses   \phpDocumentor\Reflection\Php\Visibility
- * @uses   \phpDocumentor\Reflection\PrettyPrinter
  *
  * @covers \phpDocumentor\Reflection\Php\Factory\ClassConstant
  * @covers \phpDocumentor\Reflection\Php\Factory\AbstractFactory
@@ -126,7 +125,7 @@ private function assertConstant(ConstantDescriptor $constant, string $visibility
     {
         $this->assertInstanceOf(ConstantDescriptor::class, $constant);
         $this->assertEquals('\Space\MyClass::MY_CONST1', (string) $constant->getFqsen());
-        $this->assertEquals('a', $constant->getValue());
+        $this->assertEquals('\'a\'', $constant->getValue());
         $this->assertEquals($visibility, (string) $constant->getVisibility());
     }
 }

tests/unit/phpDocumentor/Reflection/Php/Factory/ClassConstantTest.php

@@ -19,7 +19,6 @@
 use phpDocumentor\Reflection\Php\ProjectFactoryStrategies;
 use phpDocumentor\Reflection\Php\ProjectFactoryStrategy;
 use phpDocumentor\Reflection\Php\StrategyContainer;
-use phpDocumentor\Reflection\PrettyPrinter;
 use phpDocumentor\Reflection\Types\Context;
 use PhpParser\Comment\Doc;
 use PhpParser\Node\Arg;
@@ -28,13 +27,13 @@
 use PhpParser\Node\Name;
 use PhpParser\Node\Scalar\String_;
 use PhpParser\Node\Stmt\Expression;
+use PhpParser\PrettyPrinter\Standard as PrettyPrinter;
 use stdClass;
 
 /**
  * @uses   \phpDocumentor\Reflection\Php\ProjectFactoryStrategies
  * @uses   \phpDocumentor\Reflection\Php\Constant
  * @uses   \phpDocumentor\Reflection\Php\Visibility
- * @uses   \phpDocumentor\Reflection\PrettyPrinter
  *
  * @covers \phpDocumentor\Reflection\Php\Factory\Define
  * @covers \phpDocumentor\Reflection\Php\Factory\AbstractFactory
@@ -127,7 +126,7 @@ private function assertConstant(ConstantDescriptor $constant) : void
     {
         $this->assertInstanceOf(ConstantDescriptor::class, $constant);
         $this->assertEquals('\Space\MyClass\MY_CONST1', (string) $constant->getFqsen());
-        $this->assertEquals('a', $constant->getValue());
+        $this->assertEquals('\'a\'', $constant->getValue());
         $this->assertEquals('public', (string) $constant->getVisibility());
     }
 }

tests/unit/phpDocumentor/Reflection/Php/Factory/DefineTest.php

@@ -20,19 +20,18 @@
 use phpDocumentor\Reflection\Php\ProjectFactoryStrategies;
 use phpDocumentor\Reflection\Php\ProjectFactoryStrategy;
 use phpDocumentor\Reflection\Php\StrategyContainer;
-use phpDocumentor\Reflection\PrettyPrinter;
 use PhpParser\Comment\Doc;
 use PhpParser\Node\Const_;
 use PhpParser\Node\Scalar\String_;
 use PhpParser\Node\Stmt\Const_ as ConstStatement;
+use PhpParser\PrettyPrinter\Standard as PrettyPrinter;
 use stdClass;
 
 /**
  * @uses   \phpDocumentor\Reflection\Php\Factory\GlobalConstantIterator
  * @uses   \phpDocumentor\Reflection\Php\ProjectFactoryStrategies
  * @uses   \phpDocumentor\Reflection\Php\Constant
  * @uses   \phpDocumentor\Reflection\Php\Visibility
- * @uses   \phpDocumentor\Reflection\PrettyPrinter
  *
  * @covers \phpDocumentor\Reflection\Php\Factory\GlobalConstant
  * @covers \phpDocumentor\Reflection\Php\Factory\AbstractFactory
@@ -101,7 +100,7 @@ private function assertConstant(ConstantDescriptor $constant) : void
     {
         $this->assertInstanceOf(ConstantDescriptor::class, $constant);
         $this->assertEquals('\Space\MyClass\MY_CONST1', (string) $constant->getFqsen());
-        $this->assertEquals('a', $constant->getValue());
+        $this->assertEquals('\'a\'', $constant->getValue());
         $this->assertEquals('public', (string) $constant->getVisibility());
     }
 }

tests/unit/phpDocumentor/Reflection/Php/Factory/GlobalConstantTest.php

@@ -20,19 +20,18 @@
 use phpDocumentor\Reflection\Php\ProjectFactoryStrategy;
 use phpDocumentor\Reflection\Php\Property as PropertyDescriptor;
 use phpDocumentor\Reflection\Php\StrategyContainer;
-use phpDocumentor\Reflection\PrettyPrinter;
 use PhpParser\Comment\Doc;
 use PhpParser\Node\Scalar\String_;
 use PhpParser\Node\Stmt\Class_ as ClassNode;
 use PhpParser\Node\Stmt\Property as PropertyNode;
 use PhpParser\Node\Stmt\PropertyProperty;
+use PhpParser\PrettyPrinter\Standard as PrettyPrinter;
 use stdClass;
 
 /**
  * @uses \phpDocumentor\Reflection\Php\Factory\PropertyIterator
  * @uses \phpDocumentor\Reflection\Php\Property
  * @uses \phpDocumentor\Reflection\Php\Visibility
- * @uses \phpDocumentor\Reflection\PrettyPrinter
  * @uses \phpDocumentor\Reflection\Php\ProjectFactoryStrategies
  * @uses \phpDocumentor\Reflection\Php\Factory\Type
  *
@@ -128,7 +127,7 @@ private function assertProperty(PropertyDescriptor $property, string $visibility
         $this->assertInstanceOf(PropertyDescriptor::class, $property);
         $this->assertEquals('\myClass::$property', (string) $property->getFqsen());
         $this->assertTrue($property->isStatic());
-        $this->assertEquals('MyDefault', $property->getDefault());
+        $this->assertEquals('\'MyDefault\'', $property->getDefault());
         $this->assertEquals($visibility, (string) $property->getVisibility());
     }
 }