[WIP] Apply Doctrine CS

.gitignore

@@ -2,3 +2,5 @@ vendor/
 phpunit.xml
 composer.lock
 .idea/
+phpcs.xml
+.phpcs-cache

composer.json

@@ -41,7 +41,8 @@
         "symfony/form": "^3.0|^4.0",
         "symfony/filesystem": "^3.0|^4.0",
         "symfony/expression-language": "^3.0|^4.0",
-        "phpunit/phpunit": "^7.1"
+        "phpunit/phpunit": "^7.1",
+        "doctrine/coding-standard": "^4.0"
     },
     "conflict": {
         "hoa/core": "*",

phpcs.xml.dist

@@ -0,0 +1,39 @@
+<?xml version="1.0"?>
+<ruleset
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd"
+>
+    <arg name="basepath" value="."/>
+    <arg name="extensions" value="php"/>
+    <arg name="parallel" value="80"/>
+    <arg name="cache" value=".phpcs-cache"/>
+    <arg name="colors"/>
+    <arg value="nps"/>
+
+    <file>src/</file>
+    <file>tests/</file>
+
+    <rule ref="Doctrine">
+        <exclude name="Generic.Formatting.SpaceAfterNot"/>
+        <exclude name="SlevomatCodingStandard.Classes.SuperfluousAbstractClassNaming"/>
+        <exclude name="SlevomatCodingStandard.Classes.SuperfluousInterfaceNaming"/>
+        <exclude name="SlevomatCodingStandard.Classes.SuperfluousExceptionNaming"/>
+        <exclude name="SlevomatCodingStandard.ControlStructures.AssignmentInCondition.AssignmentInCondition"/>
+        <exclude name="SlevomatCodingStandard.ControlStructures.DisallowYodaComparison.DisallowedYodaComparison"/>
+        <exclude name="SlevomatCodingStandard.ControlStructures.EarlyExit"/>
+    </rule>
+
+    <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHintSpacing">
+        <properties>
+            <property name="spacesCountBeforeColon" value="0"/>
+        </properties>
+    </rule>
+
+    <rule ref="PSR1.Classes.ClassDeclaration.MultipleClasses">
+        <exclude-pattern>tests/*</exclude-pattern>
+    </rule>
+
+    <rule ref="Squiz.Classes.ClassFileName.NoMatch">
+        <exclude-pattern>tests/*</exclude-pattern>
+    </rule>
+</ruleset>

src/AbstractVisitor.php

@@ -4,14 +4,14 @@
 
 namespace JMS\Serializer;
 
+use function is_array;
+
 /**
  * @internal
  */
 abstract class AbstractVisitor implements VisitorInterface
 {
-    /**
-     * @var GraphNavigatorInterface
-     */
+    /** @var GraphNavigatorInterface */
     protected $navigator;
 
     public function setNavigator(GraphNavigatorInterface $navigator): void
@@ -30,7 +30,7 @@ protected function getElementType(array $typeArray): ?array
             return null;
         }
 
-        if (isset($typeArray['params'][1]) && \is_array($typeArray['params'][1])) {
+        if (isset($typeArray['params'][1]) && is_array($typeArray['params'][1])) {
             return $typeArray['params'][1];
         } else {
             return $typeArray['params'][0];

src/Accessor/AccessorStrategyInterface.php

@@ -8,23 +8,15 @@
 use JMS\Serializer\Metadata\PropertyMetadata;
 use JMS\Serializer\SerializationContext;
 
-/**
- * @author Asmir Mustafic <goetas@gmail.com>
- */
 interface AccessorStrategyInterface
 {
     /**
-     * @param object $object
-     * @param PropertyMetadata $metadata
      * @return mixed
      */
     public function getValue(object $object, PropertyMetadata $metadata, SerializationContext $context);
 
     /**
-     * @param object $object
      * @param mixed $value
-     * @param PropertyMetadata $metadata
-     * @return void
      */
     public function setValue(object $object, $value, PropertyMetadata $metadata, DeserializationContext $context): void;
 }

src/Accessor/DefaultAccessorStrategy.php

@@ -12,22 +12,18 @@
 use JMS\Serializer\Metadata\PropertyMetadata;
 use JMS\Serializer\Metadata\StaticPropertyMetadata;
 use JMS\Serializer\SerializationContext;
+use function sprintf;
 
-/**
- * @author Asmir Mustafic <goetas@gmail.com>
- */
 final class DefaultAccessorStrategy implements AccessorStrategyInterface
 {
-    private $readAccessors = [];
-    private $writeAccessors = [];
+    private $readAccessors           = [];
+    private $writeAccessors          = [];
     private $propertyReflectionCache = [];
 
-    /**
-     * @var ExpressionEvaluatorInterface
-     */
+    /** @var ExpressionEvaluatorInterface */
     private $evaluator;
 
-    public function __construct(ExpressionEvaluatorInterface $evaluator = null)
+    public function __construct(?ExpressionEvaluatorInterface $evaluator = null)
     {
         $this->evaluator = $evaluator;
     }
@@ -49,7 +45,6 @@ public function getValue(object $object, PropertyMetadata $metadata, Serializati
             if (!isset($this->readAccessors[$metadata->class])) {
                 if ($metadata->forceReflectionAccess === true) {
                     $this->readAccessors[$metadata->class] = function ($o, $name) use ($metadata) {
-
                         $ref = $this->propertyReflectionCache[$metadata->class][$name] ?? null;
                         if ($ref === null) {
                             $ref = new \ReflectionProperty($metadata->class, $name);
@@ -81,7 +76,7 @@ public function setValue(object $object, $value, PropertyMetadata $metadata, Des
         if (null === $metadata->setter) {
             if (!isset($this->writeAccessors[$metadata->class])) {
                 if ($metadata->forceReflectionAccess === true) {
-                    $this->writeAccessors[$metadata->class] = function ($o, $name, $value) use ($metadata) {
+                    $this->writeAccessors[$metadata->class] = function ($o, $name, $value) use ($metadata): void {
                         $ref = $this->propertyReflectionCache[$metadata->class][$name] ?? null;
                         if ($ref === null) {
                             $ref = new \ReflectionProperty($metadata->class, $name);
@@ -92,7 +87,7 @@ public function setValue(object $object, $value, PropertyMetadata $metadata, Des
                         $ref->setValue($o, $value);
                     };
                 } else {
-                    $this->writeAccessors[$metadata->class] = \Closure::bind(function ($o, $name, $value) {
+                    $this->writeAccessors[$metadata->class] = \Closure::bind(function ($o, $name, $value): void {
                         $o->$name = $value;
                     }, null, $metadata->class);
                 }

src/Annotation/AccessType.php

@@ -7,8 +7,6 @@
 /**
  * @Annotation
  * @Target({"CLASS", "PROPERTY"})
- *
- * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  */
 final class AccessType
 {

src/Annotation/Accessor.php

@@ -7,18 +7,12 @@
 /**
  * @Annotation
  * @Target("PROPERTY")
- *
- * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  */
 final class Accessor
 {
-    /**
-     * @var string
-     */
+    /** @var string */
     public $getter;
 
-    /**
-     * @var string
-     */
+    /** @var string */
     public $setter;
 }

src/Annotation/AccessorOrder.php

@@ -9,7 +9,6 @@
  *
  * @Annotation
  * @Target("CLASS")
- * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  */
 final class AccessorOrder
 {
@@ -19,8 +18,6 @@ final class AccessorOrder
      */
     public $order;
 
-    /**
-     * @var array<string>
-     */
+    /** @var array<string> */
     public $custom = [];
 }

src/Annotation/Discriminator.php

@@ -16,7 +16,7 @@ class Discriminator
     /** @var string */
     public $field = 'type';
 
-    /** @var boolean */
+    /** @var bool */
     public $disabled = false;
 
     /** @var string[] */

src/Annotation/ExclusionPolicy.php

@@ -5,21 +5,23 @@
 namespace JMS\Serializer\Annotation;
 
 use JMS\Serializer\Exception\RuntimeException;
+use function is_string;
+use function strtoupper;
 
 /**
  * @Annotation
  * @Target("CLASS")
  */
 final class ExclusionPolicy
 {
-    const NONE = 'NONE';
-    const ALL = 'ALL';
+    public const NONE = 'NONE';
+    public const ALL  = 'ALL';
 
     public $policy;
 
     public function __construct(array $values)
     {
-        if (!\is_string($values['value'])) {
+        if (!is_string($values['value'])) {
             throw new RuntimeException('"value" must be a string.');
         }
 

src/Annotation/MaxDepth.php

@@ -12,7 +12,7 @@ final class MaxDepth
 {
     /**
      * @Required
-     * @var integer
+     * @var int
      */
     public $depth;
 }

src/Annotation/PostDeserialize.php

@@ -12,7 +12,6 @@
  *
  * @Annotation
  * @Target("METHOD")
- * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  */
 final class PostDeserialize
 {

src/Annotation/PreSerialize.php

@@ -13,7 +13,6 @@
  *
  * @Annotation
  * @Target("METHOD")
- * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  */
 final class PreSerialize
 {

src/Annotation/ReadOnly.php

@@ -10,8 +10,6 @@
  */
 final class ReadOnly
 {
-    /**
-     * @var boolean
-     */
+    /** @var bool */
     public $readOnly = true;
 }

src/Annotation/SerializedName.php

@@ -5,6 +5,8 @@
 namespace JMS\Serializer\Annotation;
 
 use JMS\Serializer\Exception\RuntimeException;
+use function is_string;
+use function sprintf;
 
 /**
  * @Annotation
@@ -16,7 +18,7 @@ final class SerializedName
 
     public function __construct(array $values)
     {
-        if (!isset($values['value']) || !\is_string($values['value'])) {
+        if (!isset($values['value']) || !is_string($values['value'])) {
             throw new RuntimeException(sprintf('"value" must be a string.'));
         }
 

src/Annotation/VirtualProperty.php

@@ -5,12 +5,12 @@
 namespace JMS\Serializer\Annotation;
 
 use JMS\Serializer\Exception\InvalidArgumentException;
+use function property_exists;
+use function sprintf;
 
 /**
  * @Annotation
  * @Target({"METHOD", "CLASS"})
- *
- * @author Alexander Klimenkov <alx.devel@gmail.com>
  */
 final class VirtualProperty
 {
@@ -33,4 +33,3 @@ public function __construct(array $data)
         }
     }
 }
-

src/Annotation/XmlAttribute.php

@@ -10,8 +10,6 @@
  */
 final class XmlAttribute
 {
-    /**
-     * @var string
-     */
+    /** @var string */
     public $namespace;
 }

src/Annotation/XmlCollection.php

@@ -6,23 +6,15 @@
 
 abstract class XmlCollection
 {
-    /**
-     * @var string
-     */
+    /** @var string */
     public $entry = 'entry';
 
-    /**
-     * @var boolean
-     */
+    /** @var bool */
     public $inline = false;
 
-    /**
-     * @var string
-     */
+    /** @var string */
     public $namespace;
 
-    /**
-     * @var boolean
-     */
+    /** @var bool */
     public $skipWhenEmpty = true;
 }

src/Annotation/XmlDiscriminator.php

@@ -10,18 +10,12 @@
  */
 class XmlDiscriminator
 {
-    /**
-     * @var boolean
-     */
+    /** @var bool */
     public $attribute = false;
 
-    /**
-     * @var boolean
-     */
+    /** @var bool */
     public $cdata = true;
 
-    /**
-     * @var string
-     */
+    /** @var string */
     public $namespace;
 }

src/Annotation/XmlElement.php

@@ -10,13 +10,9 @@
  */
 final class XmlElement
 {
-    /**
-     * @var boolean
-     */
+    /** @var bool */
     public $cdata = true;
 
-    /**
-     * @var string
-     */
+    /** @var string */
     public $namespace;
 }