Merge pull request #107 from Setono/phpstan

Fix some PHPStan errors

Author: loevgaard

phpstan-baseline.neon

@@ -0,0 +1,67 @@
+parameters:
+	ignoreErrors:
+		-
+			message: '#^Interface IteratorAggregate specifies template type TKey of interface Traversable as mixed but it''s already specified as \(int\|string\)\.$#'
+			identifier: generics.interfaceConflict
+			count: 1
+			path: src/FeedContext/ContextList.php
+
+		-
+			message: '#^Parameter \#1 \$context of method Setono\\SyliusFeedPlugin\\FeedContext\\ContextList\:\:add\(\) expects array\|object, mixed given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/FeedContext/ContextList.php
+
+		-
+			message: '#^PHPDoc tag @var with type Sylius\\Component\\Core\\Model\\ProductTranslationInterface\|null is not subtype of native type Sylius\\Component\\Resource\\Model\\TranslationInterface\|null\.$#'
+			identifier: varTag.nativeType
+			count: 1
+			path: src/FeedContext/Google/Shopping/ProductItemContext.php
+
+		-
+			message: '#^PHPDoc tag @var with type Sylius\\Component\\Taxonomy\\Model\\TaxonTranslationInterface\|null is not subtype of native type Sylius\\Component\\Resource\\Model\\TranslationInterface\|null\.$#'
+			identifier: varTag.nativeType
+			count: 1
+			path: src/FeedContext/Google/Shopping/ProductItemContext.php
+
+		-
+			message: '#^Parameter \#1 \$callback of function array_map expects \(callable\(Sylius\\Component\\Taxonomy\\Model\\TaxonInterface\)\: mixed\)\|null, Closure\(Sylius\\Component\\Core\\Model\\TaxonInterface\)\: string given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/FeedContext/Google/Shopping/ProductItemContext.php
+
+		-
+			message: '#^Parameter \#1 \$price of method Setono\\SyliusFeedPlugin\\Feed\\Model\\Google\\Shopping\\Product\:\:setPrice\(\) expects Setono\\SyliusFeedPlugin\\Feed\\Model\\Google\\Shopping\\Price\|null, mixed given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/FeedContext/Google/Shopping/ProductItemContext.php
+
+		-
+			message: '#^Parameter \#1 \$salePrice of method Setono\\SyliusFeedPlugin\\Feed\\Model\\Google\\Shopping\\Product\:\:setSalePrice\(\) expects Setono\\SyliusFeedPlugin\\Feed\\Model\\Google\\Shopping\\Price\|null, mixed given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/FeedContext/Google/Shopping/ProductItemContext.php
+
+		-
+			message: '#^Parameter \#1 \$translatable of method Setono\\SyliusFeedPlugin\\FeedContext\\Google\\Shopping\\ProductItemContext\:\:getTranslation\(\) expects Sylius\\Component\\Resource\\Model\\TranslatableInterface, Sylius\\Component\\Core\\Model\\ProductInterface given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/FeedContext/Google/Shopping/ProductItemContext.php
+
+		-
+			message: '#^Parameter \#1 \$translatable of method Setono\\SyliusFeedPlugin\\FeedContext\\Google\\Shopping\\ProductItemContext\:\:getTranslation\(\) expects Sylius\\Component\\Resource\\Model\\TranslatableInterface, Sylius\\Component\\Core\\Model\\TaxonInterface given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/FeedContext/Google/Shopping/ProductItemContext.php
+
+		-
+			message: '#^Parameter \#2 \$currency of class Setono\\SyliusFeedPlugin\\Feed\\Model\\Google\\Shopping\\Price constructor expects string\|Stringable, Sylius\\Component\\Currency\\Model\\CurrencyInterface given\.$#'
+			identifier: argument.type
+			count: 1
+			path: src/FeedContext/Google/Shopping/ProductItemContext.php
+
+		-
+			message: '#^PHPDoc tag @var with type array\<array\{basename\: string, path\: string\}\>\|League\\Flysystem\\DirectoryListing\<League\\Flysystem\\StorageAttributes\> is not subtype of type League\\Flysystem\\DirectoryListing\<League\\Flysystem\\StorageAttributes\>\.$#'
+			identifier: varTag.type
+			count: 1
+			path: src/Message/Handler/FinishGenerationHandler.php

phpstan.neon

@@ -1,3 +1,6 @@
+includes:
+	- phpstan-baseline.neon
+
 parameters:
     level: max
 
@@ -22,7 +25,7 @@ parameters:
         objectManagerLoader: tests/PHPStan/object_manager.php
 
     reportUnmatchedIgnoredErrors: false
-    treatPhpDocTypesAsCertain: false
+    treatPhpDocTypesAsCertain: true
 
     ignoreErrors:
         -
@@ -31,6 +34,7 @@ parameters:
                 - doctrine.associationType
                 - doctrine.columnType
                 - missingType.generics
+                - missingType.parameter
         -
             identifier: class.notFound
             message: '#League\\Flysystem\\#'

src/Controller/Action/Shop/ShowFeedAction.php

@@ -68,9 +68,8 @@ public function __invoke(string $code): StreamedResponse
             }
         }
 
-        /** @var resource|false $stream */
         $stream = $filesystem->readStream((string) $feedPath);
-        if (false === $stream) {
+        if (!\is_resource($stream)) {
             throw new RuntimeException(sprintf('An error occurred trying to read the feed file %s', $feedPath));
         }
 

src/DataProvider/DataProvider.php

@@ -23,6 +23,9 @@ class DataProvider implements DataProviderInterface
     /** @var CollectionBatcherInterface[] */
     private array $batchers = [];
 
+    /**
+     * @param class-string $class
+     */
     public function __construct(
         private readonly BatcherFactoryInterface $batcherFactory,
         private readonly QueryRebuilderInterface $queryRebuilder,
@@ -53,6 +56,7 @@ public function getBatchCount(ChannelInterface $channel, LocaleInterface $locale
 
     public function getItems(BatchInterface $batch): iterable
     {
+        /** @phpstan-ignore return.type */
         return $this->queryRebuilder->rebuild($batch)->getResult();
     }
 

src/DataProvider/DataProviderInterface.php

@@ -14,6 +14,8 @@ interface DataProviderInterface
 {
     /**
      * This will be the root class of the data provided by this data provider
+     *
+     * @return class-string
      */
     public function getClass(): string;
 

src/DependencyInjection/Compiler/RegisterFilesystemPass.php

@@ -33,6 +33,8 @@ public function process(ContainerBuilder $container): void
 
         foreach (self::PARAMETERS as $parameter) {
             $parameterValue = $container->getParameter($parameter);
+            Assert::string($parameterValue);
+
             if (!$container->hasDefinition($parameterValue)) {
                 throw new InvalidArgumentException(sprintf('No service definition exists with id "%s"', $parameterValue));
             }

src/DependencyInjection/Compiler/ValidateDataProvidersPass.php

@@ -23,6 +23,7 @@ public function process(ContainerBuilder $container): void
                 throw new InvalidArgumentException(sprintf('The service %s needs the code attribute. Something like this: <tag name="setono_sylius_feed.data_provider" code="insert code here"/>', $id));
             }
 
+            /** @var array{code?: string} $attributes */
             foreach ($tagged as $attributes) {
                 if (!isset($attributes['code'])) {
                     throw new InvalidArgumentException(sprintf('The service %s needs the code attribute. Something like this: <tag name="setono_sylius_feed.data_provider" code="insert code here"/>', $id));

src/DependencyInjection/SetonoSyliusFeedExtension.php

@@ -18,6 +18,13 @@ final class SetonoSyliusFeedExtension extends AbstractResourceExtension implemen
 {
     public function load(array $configs, ContainerBuilder $container): void
     {
+        /**
+         * @var array{
+         *     driver: string,
+         *     storage: array{feed: string, feed_tmp: string},
+         *     resources: array
+         * } $config
+         */
         $config = $this->processConfiguration($this->getConfiguration([], $container), $configs);
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
 

src/Doctrine/ORM/FeedRepository.php

@@ -13,12 +13,16 @@ class FeedRepository extends EntityRepository implements FeedRepositoryInterface
 {
     public function findOneByCode(string $code): ?FeedInterface
     {
-        return $this->createQueryBuilder('o')
+        $result = $this->createQueryBuilder('o')
             ->where('o.code = :code')
             ->setParameter('code', $code)
             ->getQuery()
             ->getOneOrNullResult()
         ;
+
+        Assert::nullOrIsInstanceOf($result, FeedInterface::class);
+
+        return $result;
     }
 
     public function findEnabled(): array
@@ -29,6 +33,7 @@ public function findEnabled(): array
             ->getResult()
         ;
 
+        Assert::isArray($res);
         Assert::allIsInstanceOf($res, FeedInterface::class);
 
         return $res;

src/Doctrine/ORM/ViolationRepository.php

@@ -19,8 +19,6 @@ public function findCountsGroupedBySeverity($feed = null): array
             $feed = (int) $feed->getId();
         }
 
-        Assert::nullOrInteger($feed);
-
         $qb = $this->createQueryBuilder('o')
             ->select('NEW Setono\SyliusFeedPlugin\DTO\SeverityCount(o.severity, count(o))')
             ->groupBy('o.severity')
@@ -32,6 +30,7 @@ public function findCountsGroupedBySeverity($feed = null): array
         }
 
         $res = $qb->getQuery()->getResult();
+        Assert::isArray($res);
         Assert::allIsInstanceOf($res, SeverityCount::class);
 
         return $res;