[Psalm] Treat MismatchingDocblockReturnType as errors

zairigimad · Nov 14, 2019 · 2a96518 · 2a96518
1 parent cb7c915
commit 2a96518
Show file tree

Hide file tree

Showing 87 changed files with 561 additions and 75 deletions.
diff --git a/etc/psalm/ZendPriorityQueueStub.php b/etc/psalm/ZendPriorityQueueStub.php
@@ -0,0 +1,125 @@
+<?php
+
+// This stub is created to support Psalm generics.
+
+/**
+ * Zend Framework (http://framework.zend.com/)
+ *
+ * @link      http://github.com/zendframework/zf2 for the canonical source repository
+ * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   http://framework.zend.com/license/new-bsd New BSD License
+ */
+
+namespace Zend\Stdlib;
+
+use Countable;
+use IteratorAggregate;
+use Serializable;
+
+/**
+ * @psalm-template T
+ * @template-extends IteratorAggregate<int, T>
+ * @template-extends ArrayAccess<int|null, T>
+ */
+class PriorityQueue implements Countable, IteratorAggregate, Serializable
+{
+    const EXTR_DATA = 0x00000001;
+    const EXTR_PRIORITY = 0x00000002;
+    const EXTR_BOTH = 0x00000003;
+
+    /**
+     * @param mixed $data
+     * @param int $priority
+     *
+     * @return PriorityQueue
+     *
+     * @psalm-param T $data
+     * @psalm-return PriorityQueue<T>
+     */
+    public function insert($data, $priority = 1) { }
+
+    /**
+     * @param mixed $datum
+     *
+     * @return bool False if the item was not found, true otherwise.
+     *
+     * @psalm-param T $datum
+     */
+    public function remove($datum) { }
+
+    /**
+     * @return bool
+     */
+    public function isEmpty() { }
+
+    /**
+     * @return int
+     */
+    public function count() { }
+
+    /**
+     * @return mixed
+     */
+    public function top() { }
+
+    /**
+     * @return mixed
+     */
+    public function extract() { }
+
+    /**
+     * @return SplPriorityQueue
+     *
+     * @psalm-return SplPriorityQueue<T>
+     */
+    public function getIterator() { }
+
+    /**
+     * @return string
+     */
+    public function serialize() { }
+
+    /**
+     * @param string $data
+     *
+     * @return void
+     */
+    public function unserialize($data) { }
+
+    /**
+     * @param int $flag
+     *
+     * @return array
+     */
+    public function toArray($flag = self::EXTR_DATA) { }
+
+    /**
+     * @param string $class
+     *
+     * @return PriorityQueue
+     *
+     * @psalm-return PriorityQueue<T>
+     */
+    public function setInternalQueueClass($class) { }
+
+    /**
+     * @param mixed $datum
+     *
+     * @return bool
+     *
+     * @psalm-param T $datum
+     */
+    public function contains($datum) { }
+
+    /**
+     * @param int $priority
+     *
+     * @return bool
+     */
+    public function hasPriority($priority) { }
+
+    /**
+     * @return void
+     */
+    public function __clone() { }
+}
diff --git a/psalm.xml b/psalm.xml
@@ -199,10 +199,13 @@
 
         <!-- Custom -->
 
-        <MismatchingDocblockReturnType errorLevel="info" />
         <!-- remove after guzzlehttp-release -->
         <!-- see https://github.com/guzzle/guzzle/pull/2273 -->
         <InvalidCatch errorLevel="info" />
 
     </issueHandlers>
+
+    <stubs>
+        <file name="etc/psalm/ZendPriorityQueueStub.php" />
+    </stubs>
 </psalm>
diff --git a/src/Sylius/Bundle/AddressingBundle/SyliusAddressingBundle.php b/src/Sylius/Bundle/AddressingBundle/SyliusAddressingBundle.php
@@ -29,7 +29,7 @@ public function getSupportedDrivers(): array
     }
 
     /**
-     * {@inheritdoc}
+     * @psalm-suppress MismatchingDocblockReturnType https://github.com/vimeo/psalm/issues/2345
      */
     protected function getModelNamespace(): string
     {

diff --git a/src/Sylius/Bundle/AttributeBundle/SyliusAttributeBundle.php b/src/Sylius/Bundle/AttributeBundle/SyliusAttributeBundle.php
@@ -43,7 +43,7 @@ public function build(ContainerBuilder $container): void
     }
 
     /**
-     * {@inheritdoc}
+     * @psalm-suppress MismatchingDocblockReturnType https://github.com/vimeo/psalm/issues/2345
      */
     protected function getModelNamespace(): string
     {

diff --git a/src/Sylius/Bundle/ChannelBundle/SyliusChannelBundle.php b/src/Sylius/Bundle/ChannelBundle/SyliusChannelBundle.php
@@ -43,7 +43,7 @@ public function build(ContainerBuilder $container): void
     }
 
     /**
-     * {@inheritdoc}
+     * @psalm-suppress MismatchingDocblockReturnType https://github.com/vimeo/psalm/issues/2345
      */
     protected function getModelNamespace(): string
     {

diff --git a/src/Sylius/Bundle/CoreBundle/SyliusCoreBundle.php b/src/Sylius/Bundle/CoreBundle/SyliusCoreBundle.php
@@ -49,7 +49,7 @@ public function build(ContainerBuilder $container): void
     }
 
     /**
-     * {@inheritdoc}
+     * @psalm-suppress MismatchingDocblockReturnType https://github.com/vimeo/psalm/issues/2345
      */
     protected function getModelNamespace(): string
     {

diff --git a/...ylius/Bundle/CoreBundle/Validator/Constraints/OrderShippingMethodEligibilityValidator.php b/...ylius/Bundle/CoreBundle/Validator/Constraints/OrderShippingMethodEligibilityValidator.php
@@ -50,8 +50,6 @@ public function validate($order, Constraint $constraint): void
 
         foreach ($shipments as $shipment) {
             if (!$this->methodEligibilityChecker->isEligible($shipment, $shipment->getMethod())) {
-                Assert::isInstanceOf($shipment, ShipmentInterface::class);
-
                 $this->context->addViolation(
                     $constraint->message,
                     ['%shippingMethodName%' => $shipment->getMethod()->getName()]

diff --git a/src/Sylius/Bundle/CurrencyBundle/SyliusCurrencyBundle.php b/src/Sylius/Bundle/CurrencyBundle/SyliusCurrencyBundle.php
@@ -42,7 +42,7 @@ public function getSupportedDrivers(): array
     }
 
     /**
-     * {@inheritdoc}
+     * @psalm-suppress MismatchingDocblockReturnType https://github.com/vimeo/psalm/issues/2345
      */
     protected function getModelNamespace(): string
     {

diff --git a/src/Sylius/Bundle/CustomerBundle/SyliusCustomerBundle.php b/src/Sylius/Bundle/CustomerBundle/SyliusCustomerBundle.php
@@ -29,7 +29,7 @@ public function getSupportedDrivers(): array
     }
 
     /**
-     * {@inheritdoc}
+     * @psalm-suppress MismatchingDocblockReturnType https://github.com/vimeo/psalm/issues/2345
      */
     protected function getModelNamespace(): string
     {

diff --git a/src/Sylius/Bundle/InventoryBundle/SyliusInventoryBundle.php b/src/Sylius/Bundle/InventoryBundle/SyliusInventoryBundle.php
@@ -30,7 +30,7 @@ public function getSupportedDrivers(): array
     }
 
     /**
-     * {@inheritdoc}
+     * @psalm-suppress MismatchingDocblockReturnType https://github.com/vimeo/psalm/issues/2345
      */
     protected function getModelNamespace(): string
     {

diff --git a/src/Sylius/Bundle/LocaleBundle/SyliusLocaleBundle.php b/src/Sylius/Bundle/LocaleBundle/SyliusLocaleBundle.php
@@ -42,7 +42,7 @@ public function getSupportedDrivers(): array
     }
 
     /**
-     * {@inheritdoc}
+     * @psalm-suppress MismatchingDocblockReturnType https://github.com/vimeo/psalm/issues/2345
      */
     protected function getModelNamespace(): string
     {

diff --git a/src/Sylius/Bundle/OrderBundle/SyliusOrderBundle.php b/src/Sylius/Bundle/OrderBundle/SyliusOrderBundle.php
@@ -43,7 +43,7 @@ public function build(ContainerBuilder $container): void
     }
 
     /**
-     * {@inheritdoc}
+     * @psalm-suppress MismatchingDocblockReturnType https://github.com/vimeo/psalm/issues/2345
      */
     protected function getModelNamespace(): string
     {

diff --git a/src/Sylius/Bundle/PaymentBundle/SyliusPaymentBundle.php b/src/Sylius/Bundle/PaymentBundle/SyliusPaymentBundle.php
@@ -44,7 +44,7 @@ public function build(ContainerBuilder $container): void
     }
 
     /**
-     * {@inheritdoc}
+     * @psalm-suppress MismatchingDocblockReturnType https://github.com/vimeo/psalm/issues/2345
      */
     protected function getModelNamespace(): string
     {

diff --git a/...s/Bundle/ProductBundle/Form/DataTransformer/ProductVariantToProductOptionsTransformer.php b/...s/Bundle/ProductBundle/Form/DataTransformer/ProductVariantToProductOptionsTransformer.php
@@ -47,7 +47,6 @@ public function transform($value): array
 
         return array_combine(
             array_map(
-                /** @psalm-return array-key */
                 function (ProductOptionValueInterface $productOptionValue): string {
                     return (string) $productOptionValue->getOptionCode();
                 },
@@ -78,7 +77,7 @@ public function reverseTransform($value): ?ProductVariantInterface
      *
      * @throws TransformationFailedException
      */
-    private function matches(array $optionValues): ?ProductVariantInterface
+    private function matches(array $optionValues): ProductVariantInterface
     {
         foreach ($this->product->getVariants() as $variant) {
             foreach ($optionValues as $optionValue) {

diff --git a/...us/Bundle/ProductBundle/Form/DataTransformer/ProductsToProductAssociationsTransformer.php b/...us/Bundle/ProductBundle/Form/DataTransformer/ProductsToProductAssociationsTransformer.php
@@ -34,7 +34,11 @@ final class ProductsToProductAssociationsTransformer implements DataTransformerI
     /** @var RepositoryInterface */
     private $productAssociationTypeRepository;
 
-    /** @var Collection<array-key, ProductAssociationInterface> */
+    /**
+     * @var Collection|ProductAssociationInterface[]
+     *
+     * @psalm-var Collection<array-key, ProductAssociationInterface>
+     */
     private $productAssociations;
 
     public function __construct(
@@ -79,7 +83,9 @@ public function reverseTransform($values): ?Collection
             return null;
         }
 
-        /** @var Collection<array-key, ProductAssociationInterface> $productAssociations */
+        /**
+         * @psalm-var Collection<array-key, ProductAssociationInterface> $productAssociations
+         */
         $productAssociations = new ArrayCollection();
         foreach ($values as $productAssociationTypeCode => $productCodes) {
             if (null === $productCodes) {

diff --git a/src/Sylius/Bundle/ProductBundle/SyliusProductBundle.php b/src/Sylius/Bundle/ProductBundle/SyliusProductBundle.php
@@ -29,7 +29,7 @@ public function getSupportedDrivers(): array
     }
 
     /**
-     * {@inheritdoc}
+     * @psalm-suppress MismatchingDocblockReturnType https://github.com/vimeo/psalm/issues/2345
      */
     protected function getModelNamespace(): string
     {

diff --git a/src/Sylius/Bundle/PromotionBundle/SyliusPromotionBundle.php b/src/Sylius/Bundle/PromotionBundle/SyliusPromotionBundle.php
@@ -48,7 +48,7 @@ public function build(ContainerBuilder $container): void
     }
 
     /**
-     * {@inheritdoc}
+     * @psalm-suppress MismatchingDocblockReturnType https://github.com/vimeo/psalm/issues/2345
      */
     protected function getModelNamespace(): string
     {

diff --git a/src/Sylius/Bundle/PromotionBundle/test/src/AppBundle/Entity/PromotionSubject.php b/src/Sylius/Bundle/PromotionBundle/test/src/AppBundle/Entity/PromotionSubject.php
@@ -31,7 +31,11 @@ class PromotionSubject implements ResourceInterface, PromotionSubjectInterface
     /** @var int */
     private $id;
 
-    /** @var Collection|PromotionInterface[] */
+    /**
+     * @var Collection|PromotionInterface[]
+     *
+     * @psalm-var Collection<array-key, PromotionInterface>
+     */
     protected $promotions;
 
     /**

diff --git a/src/Sylius/Bundle/ReviewBundle/SyliusReviewBundle.php b/src/Sylius/Bundle/ReviewBundle/SyliusReviewBundle.php
@@ -41,7 +41,7 @@ public function build(ContainerBuilder $container): void
     }
 
     /**
-     * {@inheritdoc}
+     * @psalm-suppress MismatchingDocblockReturnType https://github.com/vimeo/psalm/issues/2345
      */
     protected function getModelNamespace(): string
     {

diff --git a/src/Sylius/Bundle/ShippingBundle/SyliusShippingBundle.php b/src/Sylius/Bundle/ShippingBundle/SyliusShippingBundle.php
@@ -43,7 +43,7 @@ public function build(ContainerBuilder $container): void
     }
 
     /**
-     * {@inheritdoc}
+     * @psalm-suppress MismatchingDocblockReturnType https://github.com/vimeo/psalm/issues/2345
      */
     protected function getModelNamespace(): string
     {

diff --git a/src/Sylius/Bundle/ShopBundle/EventListener/OrderIntegrityChecker.php b/src/Sylius/Bundle/ShopBundle/EventListener/OrderIntegrityChecker.php
@@ -51,6 +51,7 @@ public function check(ResourceControllerEvent $event): void
         /** @var OrderInterface $order */
         Assert::isInstanceOf($order, OrderInterface::class);
 
+        /** @var ArrayCollection<array-key, PromotionInterface> $previousPromotions */
         $previousPromotions = new ArrayCollection($order->getPromotions()->toArray());
         $oldTotal = $order->getTotal();
 

diff --git a/src/Sylius/Bundle/TaxationBundle/SyliusTaxationBundle.php b/src/Sylius/Bundle/TaxationBundle/SyliusTaxationBundle.php
@@ -41,7 +41,7 @@ public function build(ContainerBuilder $container): void
     }
 
     /**
-     * {@inheritdoc}
+     * @psalm-suppress MismatchingDocblockReturnType https://github.com/vimeo/psalm/issues/2345
      */
     protected function getModelNamespace(): string
     {

diff --git a/src/Sylius/Bundle/TaxonomyBundle/SyliusTaxonomyBundle.php b/src/Sylius/Bundle/TaxonomyBundle/SyliusTaxonomyBundle.php
@@ -30,7 +30,7 @@ public function getSupportedDrivers(): array
     }
 
     /**
-     * {@inheritdoc}
+     * @psalm-suppress MismatchingDocblockReturnType https://github.com/vimeo/psalm/issues/2345
      */
     protected function getModelNamespace(): string
     {

diff --git a/src/Sylius/Bundle/UserBundle/SyliusUserBundle.php b/src/Sylius/Bundle/UserBundle/SyliusUserBundle.php
@@ -29,7 +29,7 @@ public function getSupportedDrivers(): array
     }
 
     /**
-     * {@inheritdoc}
+     * @psalm-suppress MismatchingDocblockReturnType https://github.com/vimeo/psalm/issues/2345
      */
     protected function getModelNamespace(): string
     {

diff --git a/src/Sylius/Component/Addressing/Model/Country.php b/src/Sylius/Component/Addressing/Model/Country.php
@@ -32,11 +32,16 @@ class Country implements CountryInterface
      */
     protected $code;
 
-    /** @var Collection|ProvinceInterface[] */
+    /**
+     * @var Collection|ProvinceInterface[]
+     *
+     * @psalm-var Collection<array-key, ProvinceInterface>
+     */
     protected $provinces;
 
     public function __construct()
     {
+        /** @var ArrayCollection<array-key, ProvinceInterface> $this->provinces */
         $this->provinces = new ArrayCollection();
     }
 

diff --git a/src/Sylius/Component/Addressing/Model/CountryInterface.php b/src/Sylius/Component/Addressing/Model/CountryInterface.php
@@ -24,6 +24,8 @@ public function getName(?string $locale = null): ?string;
 
     /**
      * @return Collection|ProvinceInterface[]
+     *
+     * @psalm-return Collection<array-key, ProvinceInterface>
      */
     public function getProvinces(): Collection;
-Original file line number
+Diff line change
@@ Expand Up / @@ -29,7 +29,7 @@ public function getSupportedDrivers(): array @@
         }
         /**
-         * {@inheritdoc}
+         * @psalm-suppress MismatchingDocblockReturnType https://github.com/vimeo/psalm/issues/2345
          */
         protected function getModelNamespace(): string
         {
@@ Expand Down @@