Merge pull request #191 from loic425/features/psalm-level-5

psalm level 5

Makefile.dist

@@ -21,7 +21,7 @@ stop:
 
 test: validate-all test-all
 
-test-all: test-phpspec test-phpstan test-phpunit test-infection test-all-behat
+test-all: test-phpspec test-phpstan test-phpstan test-phpunit test-infection test-all-behat
 
 test-behat:
 	APP_ENV=test vendor/bin/behat --tags=${TAGS} ${ARGS}
@@ -45,11 +45,14 @@ test-infection:
 test-phpspec:
 	phpdbg -qrr vendor/bin/phpspec run -n ${ARGS}
 
-test-phpstan::
+test-phpstan:
 	APP_ENV=dev bin/console cache:clear
 	APP_ENV=dev bin/console cache:warmup
 	vendor/bin/phpstan analyse -c phpstan.neon -l 1 src
 
+test-psalm:
+	vendor/bin/psalm --show-info=false
+
 test-phpunit:
 	APP_ENV=test vendor/bin/phpunit ${ARGS}
 

psalm.xml

@@ -104,20 +104,5 @@
         <MissingDocblockType errorLevel="info" />
         <ImplementedReturnTypeMismatch errorLevel="info" />
 
-        <!-- level 6 issues - really bad things -->
-
-        <InvalidNullableReturnType errorLevel="info" />
-        <NullableReturnStatement errorLevel="info" />
-        <InvalidFalsableReturnType errorLevel="info" />
-        <FalsableReturnStatement errorLevel="info" />
-
-        <MoreSpecificImplementedParamType errorLevel="info" />
-        <LessSpecificImplementedReturnType errorLevel="info" />
-
-        <InvalidReturnStatement errorLevel="info" />
-        <InvalidReturnType errorLevel="info" />
-        <UndefinedThisPropertyAssignment errorLevel="info" />
-        <UndefinedInterfaceMethod errorLevel="info" />
-
     </issueHandlers>
 </psalm>

spec/App/EventListener/DefaultUsernameORMListenerSpec.php

@@ -4,7 +4,7 @@
 
 namespace spec\App\EventListener;
 
-use App\Entity\Customer;
+use App\Entity\CustomerInterface;
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\Event\OnFlushEventArgs;
 use Doctrine\ORM\Mapping\ClassMetadata;
@@ -19,7 +19,7 @@ function it_sets_usernames_on_customer_create(
         OnFlushEventArgs $onFlushEventArgs,
         EntityManager $entityManager,
         UnitOfWork $unitOfWork,
-        Customer $customer,
+        CustomerInterface $customer,
         UserInterface $user,
         ClassMetadata $userMetadata
     ): void {
@@ -48,7 +48,7 @@ function it_updates_usernames_on_customer_email_change(
         OnFlushEventArgs $onFlushEventArgs,
         EntityManager $entityManager,
         UnitOfWork $unitOfWork,
-        Customer $customer,
+        CustomerInterface $customer,
         UserInterface $user,
         ClassMetadata $userMetadata
     ): void {
@@ -77,7 +77,7 @@ function it_updates_usernames_on_customer_email_canonical_change(
         OnFlushEventArgs $onFlushEventArgs,
         EntityManager $entityManager,
         UnitOfWork $unitOfWork,
-        Customer $customer,
+        CustomerInterface $customer,
         UserInterface $user,
         ClassMetadata $userMetadata
     ): void {
@@ -106,7 +106,7 @@ function it_does_not_update_usernames_when_customer_emails_are_the_same(
         OnFlushEventArgs $onFlushEventArgs,
         EntityManager $entityManager,
         UnitOfWork $unitOfWork,
-        Customer $customer,
+        CustomerInterface $customer,
         UserInterface $user,
         ClassMetadata $userMetadata
     ): void {
@@ -134,7 +134,7 @@ function it_does_nothing_on_customer_create_when_no_user_associated(
         OnFlushEventArgs $onFlushEventArgs,
         EntityManager $entityManager,
         UnitOfWork $unitOfWork,
-        Customer $customer
+        CustomerInterface $customer
     ): void {
         $onFlushEventArgs->getEntityManager()->willReturn($entityManager);
         $entityManager->getUnitOfWork()->willReturn($unitOfWork);
@@ -153,7 +153,7 @@ function it_does_nothing_on_customer_update_when_no_user_associated(
         OnFlushEventArgs $onFlushEventArgs,
         EntityManager $entityManager,
         UnitOfWork $unitOfWork,
-        Customer $customer
+        CustomerInterface $customer
     ): void {
         $onFlushEventArgs->getEntityManager()->willReturn($entityManager);
         $entityManager->getUnitOfWork()->willReturn($unitOfWork);
@@ -208,7 +208,7 @@ function it_skips_objects_other_than_customers(
         EntityManager $entityManager,
         UnitOfWork $unitOfWork,
         \stdClass $stdObject,
-        Customer $customer,
+        CustomerInterface $customer,
         UserInterface $user,
         ClassMetadata $userMetadata
     ): void {
@@ -238,8 +238,8 @@ function it_skips_customers_without_users_associated(
         OnFlushEventArgs $onFlushEventArgs,
         EntityManager $entityManager,
         UnitOfWork $unitOfWork,
-        Customer $customerWithoutUser,
-        Customer $customerWithUser,
+        CustomerInterface $customerWithoutUser,
+        CustomerInterface $customerWithUser,
         UserInterface $user,
         ClassMetadata $userMetadata
     ): void {
@@ -271,8 +271,8 @@ function it_skips_customers_with_same_emails(
         OnFlushEventArgs $onFlushEventArgs,
         EntityManager $entityManager,
         UnitOfWork $unitOfWork,
-        Customer $customerWithSameEmail,
-        Customer $customerWithDifferentEmail,
+        CustomerInterface $customerWithSameEmail,
+        CustomerInterface $customerWithDifferentEmail,
         UserInterface $userWithSameEmail,
         UserInterface $userWithDifferentEmail,
         ClassMetadata $userMetadata

spec/App/EventListener/PasswordUpdaterListenerSpec.php

@@ -4,7 +4,7 @@
 
 namespace spec\App\EventListener;
 
-use App\Entity\Customer;
+use App\Entity\CustomerInterface;
 use PhpSpec\ObjectBehavior;
 use Sylius\Component\User\Model\UserInterface;
 use Sylius\Component\User\Security\PasswordUpdaterInterface;
@@ -21,7 +21,7 @@ function it_updates_password_for_customer(
         PasswordUpdaterInterface $passwordUpdater,
         GenericEvent $event,
         UserInterface $user,
-        Customer $customer
+        CustomerInterface $customer
     ): void {
         $event->getSubject()->willReturn($customer);
         $customer->getUser()->willReturn($user);
@@ -44,7 +44,7 @@ function it_does_not_update_password_if_subject_is_not_instance_of_customer_inte
     function it_does_not_update_password_if_customer_does_not_have_user(
         PasswordUpdaterInterface $passwordUpdater,
         GenericEvent $event,
-        Customer $customer
+        CustomerInterface $customer
     ): void {
         $event->getSubject()->willReturn($customer);
         $customer->getUser()->willReturn(null);

spec/App/Form/EventSubscriber/CustomerRegistrationFormSubscriberSpec.php

@@ -4,7 +4,7 @@
 
 namespace spec\App\Form\EventSubscriber;
 
-use App\Entity\Customer;
+use App\Entity\CustomerInterface;
 use PhpSpec\ObjectBehavior;
 use App\Entity\AppUser;
 use Sylius\Component\Resource\Repository\RepositoryInterface;
@@ -33,9 +33,9 @@ function it_listens_on_pre_submit_data_event(): void
     function it_sets_user_for_existing_customer(
         FormEvent $event,
         FormInterface $form,
-        Customer $customer,
+        CustomerInterface $customer,
         RepositoryInterface $customerRepository,
-        Customer $existingCustomer,
+        CustomerInterface $existingCustomer,
         AppUser $user
     ): void {
         $event->getForm()->willReturn($form);
@@ -68,9 +68,9 @@ function it_throws_unexpected_type_exception_if_data_is_not_customer_type(
     function it_does_not_set_user_if_customer_with_given_email_has_set_user(
         FormEvent $event,
         FormInterface $form,
-        Customer $customer,
+        CustomerInterface $customer,
         RepositoryInterface $customerRepository,
-        Customer $existingCustomer,
+        CustomerInterface $existingCustomer,
         AppUser $user
     ): void {
         $event->getForm()->willReturn($form);
@@ -90,9 +90,9 @@ function it_does_not_set_user_if_customer_with_given_email_has_set_user(
     function it_does_not_set_user_if_email_is_empty(
         FormEvent $event,
         FormInterface $form,
-        Customer $customer,
+        CustomerInterface $customer,
         RepositoryInterface $customerRepository,
-        Customer $existingCustomer,
+        CustomerInterface $existingCustomer,
         AppUser $user
     ): void {
         $event->getForm()->willReturn($form);

src/Command/Installer/SetupCommand.php

@@ -15,6 +15,7 @@
 use Doctrine\Common\Persistence\ObjectManager;
 use Sylius\Component\Resource\Factory\FactoryInterface;
 use Sylius\Component\Resource\Repository\RepositoryInterface;
+use Sylius\Component\User\Repository\UserRepositoryInterface;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Helper\QuestionHelper;
 use Symfony\Component\Console\Input\InputInterface;
@@ -28,36 +29,22 @@
 
 final class SetupCommand extends Command
 {
-    /**
-     * @var ObjectManager
-     */
+    /** @var ObjectManager */
     private $adminUserManager;
 
-    /**
-     * @var FactoryInterface
-     */
+    /** @var FactoryInterface */
     private $adminUserFactory;
 
-    /**
-     * @var RepositoryInterface
-     */
+    /** @var UserRepositoryInterface */
     private $adminUserRepository;
 
-    /**
-     * @var ValidatorInterface
-     */
+    /** @var ValidatorInterface */
     private $validator;
 
-    /**
-     * @param ObjectManager       $adminUserManager
-     * @param FactoryInterface    $adminUserFactory
-     * @param RepositoryInterface $adminUserRepository
-     * @param ValidatorInterface  $validator
-     */
     public function __construct(
         ObjectManager $adminUserManager,
         FactoryInterface $adminUserFactory,
-        RepositoryInterface $adminUserRepository,
+        UserRepositoryInterface $adminUserRepository,
         ValidatorInterface $validator
     ) {
         $this->adminUserManager = $adminUserManager;
@@ -94,17 +81,15 @@ protected function execute(InputInterface $input, OutputInterface $output)
     /**
      * @param InputInterface  $input
      * @param OutputInterface $output
-     *
-     * @return int
      */
-    protected function setupAdministratorUser(InputInterface $input, OutputInterface $output)
+    protected function setupAdministratorUser(InputInterface $input, OutputInterface $output): void
     {
         $output->writeln('Create your administrator account.');
 
         try {
             $user = $this->configureNewUser($this->adminUserFactory->createNew(), $input, $output);
         } catch (\InvalidArgumentException $exception) {
-            return 0;
+            return;
         }
 
         $user->setEnabled(true);

src/DependencyInjection/Configuration.php

@@ -7,7 +7,7 @@
 
 class Configuration implements ConfigurationInterface
 {
-    public function getConfigTreeBuilder()
+    public function getConfigTreeBuilder(): void
     {
         $treeBuilder = new TreeBuilder();
         $rootNode = $treeBuilder->root('app');

src/EventListener/DefaultUsernameORMListener.php

@@ -15,7 +15,7 @@
 use Doctrine\ORM\Event\OnFlushEventArgs;
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\UnitOfWork;
-use Sylius\Component\Customer\Model\CustomerInterface;
+use App\Entity\CustomerInterface;
 use Sylius\Component\User\Model\UserInterface;
 
 /**

src/EventListener/PasswordUpdaterListener.php

@@ -11,8 +11,8 @@
 
 namespace App\EventListener;
 
+use App\Entity\CustomerInterface;
 use Sylius\Bundle\UserBundle\EventListener\PasswordUpdaterListener as BasePasswordUpdaterListener;
-use Sylius\Component\Customer\Model\CustomerInterface;
 use Sylius\Component\Resource\Exception\UnexpectedTypeException;
 use Symfony\Component\EventDispatcher\GenericEvent;
 

src/Form/EventSubscriber/CustomerRegistrationFormSubscriber.php

@@ -11,7 +11,7 @@
 
 namespace App\Form\EventSubscriber;
 
-use Sylius\Component\Customer\Model\CustomerInterface;
+use App\Entity\CustomerInterface;
 use Sylius\Component\Resource\Repository\RepositoryInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\Form\Exception\UnexpectedTypeException;

src/Installer/Provider/DatabaseSetupCommandsProvider.php

@@ -13,6 +13,7 @@
 
 use Doctrine\Bundle\DoctrineBundle\Registry;
 use Doctrine\DBAL\Schema\AbstractSchemaManager;
+use Doctrine\ORM\EntityManagerInterface;
 use Symfony\Component\Console\Helper\QuestionHelper;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -143,14 +144,20 @@ private function isSchemaPresent()
      */
     private function getDatabaseName()
     {
-        return $this->doctrineRegistry->getManager()->getConnection()->getDatabase();
+        /** @var EntityManagerInterface $manager */
+        $manager = $this->doctrineRegistry->getManager();
+
+        return $manager->getConnection()->getDatabase();
     }
 
     /**
      * @return AbstractSchemaManager
      */
     private function getSchemaManager()
     {
-        return $this->doctrineRegistry->getManager()->getConnection()->getSchemaManager();
+        /** @var EntityManagerInterface $manager */
+        $manager = $this->doctrineRegistry->getManager();
+
+        return $manager->getConnection()->getSchemaManager();
     }
 }