fixes

odiseoteam · Sep 29, 2020 · d3e5b38 · d3e5b38
1 parent 25d1e83
commit d3e5b38
Show file tree

Hide file tree

Showing 30 changed files with 92 additions and 90 deletions.
diff --git a/.gitignore b/.gitignore
@@ -14,3 +14,4 @@
 
 /behat.yml
 /phpspec.yml
+/phpunit.xml
diff --git a/.travis.yml b/.travis.yml
@@ -68,6 +68,7 @@ script:
     - composer validate
 
     - vendor/bin/phpstan analyse -c phpstan.neon -l max src/
+    - vendor/bin/psalm
 
     - vendor/bin/phpunit
     - vendor/bin/phpspec run

diff --git a/bin/behat b/bin/behat
diff --git a/bin/console b/bin/console
diff --git a/bin/doctrine b/bin/doctrine
diff --git a/bin/doctrine-dbal b/bin/doctrine-dbal
diff --git a/bin/doctrine-migrations b/bin/doctrine-migrations
diff --git a/bin/ecs b/bin/ecs
diff --git a/bin/php-cs-fixer b/bin/php-cs-fixer
diff --git a/bin/phpcbf b/bin/phpcbf
diff --git a/bin/phpcs b/bin/phpcs
diff --git a/bin/phpspec b/bin/phpspec
diff --git a/bin/phpstan b/bin/phpstan
diff --git a/bin/phpstan.phar b/bin/phpstan.phar
diff --git a/bin/phpunit b/bin/phpunit
diff --git a/bin/security-checker b/bin/security-checker
diff --git a/bin/update-psl-icann-section b/bin/update-psl-icann-section
diff --git a/bin/upload-screenshots b/bin/upload-screenshots
diff --git a/bin/upload-textfiles b/bin/upload-textfiles
diff --git a/bin/var-dump-server b/bin/var-dump-server
diff --git a/bin/wait-for-port b/bin/wait-for-port
diff --git a/composer.json b/composer.json
@@ -55,11 +55,6 @@
     "autoload-dev": {
         "classmap": ["tests/Application/Kernel.php"]
     },
-    "extra": {
-        "branch-alias": {
-            "dev-master": "1.8-dev"
-        }
-    },
     "config": {
         "sort-packages": true
     },

diff --git a/doc/tests.md b/doc/tests.md
@@ -1,17 +1,19 @@
 ## Test the plugin
 
-We are using Behat, PHPSpec and PHPUnit to test this plugin.
+We are using PHPStan, Psalm, Behat, PHPSpec and PHPUnit to test this plugin.
 
 ### How to run the tests
 
 From the plugin root directory, run the following commands:
 
+    ```bash
     $ (cd tests/Application && yarn install)
     $ (cd tests/Application && yarn build)
-    $ (cd tests/Application && bin/console assets:install public -e test)
+    $ (cd tests/Application && APP_ENV=test bin/console assets:install public)
 
-    $ (cd tests/Application && bin/console doctrine:database:create -e test)
-    $ (cd tests/Application && bin/console doctrine:schema:create -e test)
+    $ (cd tests/Application && APP_ENV=test bin/console doctrine:database:create)
+    $ (cd tests/Application && APP_ENV=test bin/console doctrine:schema:create)
+    ```
 
 To be able to setup a plugin's database, remember to configure you database credentials in `tests/Application/.env` and `tests/Application/.env.test`.
 
@@ -22,33 +24,75 @@ To be able to setup a plugin's database, remember to configure you database cred
   - PHPUnit
 
     ```bash
-    $ bin/phpunit
+    $ vendor/bin/phpunit
     ```
 
   - PHPSpec
 
     ```bash
-    $ bin/phpspec run
+    $ vendor/bin/phpspec run
+    ```
+
+  - Behat (non-JS scenarios)
+
+    ```bash
+    $ vendor/bin/behat --strict --tags="~@javascript"
     ```
 
-  - Behat
+  - Behat (JS scenarios)
+
+    1. [Install Symfony CLI command](https://symfony.com/download).
+
+    2. Start Headless Chrome:
+
+      ```bash
+      $ google-chrome-stable --enable-automation --disable-background-networking --no-default-browser-check --no-first-run --disable-popup-blocking --disable-default-apps --allow-insecure-localhost --disable-translate --disable-extensions --no-sandbox --enable-features=Metal --headless --remote-debugging-port=9222 --window-size=2880,1800 --proxy-server='direct://' --proxy-bypass-list='*' http://127.0.0.1
+      ```
+
+    3. Install SSL certificates (only once needed) and run test application's webserver on `127.0.0.1:8080`:
+
+      ```bash
+      $ symfony server:ca:install APP_ENV=test symfony server:start --port=8080 --dir=tests/Application/public --daemon
+      ```
+
+    4. Run Behat:
+
+      ```bash
+      $ vendor/bin/behat --strict --tags="@javascript"
+      ```
+
+  - Static Analysis
+
+    - Psalm
+
+      ```bash
+      $ vendor/bin/psalm
+      ```
+
+    - PHPStan
+
+      ```bash
+      $ vendor/bin/phpstan analyse -c phpstan.neon -l max src/
+      ```
+
+  - Coding Standard
 
     ```bash
-    $ bin/behat
+    $ vendor/bin/ecs check src
     ```
 
 ### Opening Sylius with this plugin
 
 - Using `test` environment:
 
     ```bash
-    $ (cd tests/Application && bin/console sylius:fixtures:load -e test)
-    $ (cd tests/Application && bin/console server:run -d public -e test)
+    $ (cd tests/Application && APP_ENV=test bin/console sylius:fixtures:load)
+    $ (cd tests/Application && APP_ENV=test bin/console server:run -d public)
     ```
 
 - Using `dev` environment:
 
     ```bash
-    $ (cd tests/Application && bin/console sylius:fixtures:load -e dev)
-    $ (cd tests/Application && bin/console server:run -d public -e dev)
+    $ (cd tests/Application && APP_ENV=dev bin/console sylius:fixtures:load)
+    $ (cd tests/Application && APP_ENV=dev bin/console server:run -d public)
     ```
diff --git a/psalm.xml b/psalm.xml
@@ -12,4 +12,15 @@
             <directory name="vendor" />
         </ignoreFiles>
     </projectFiles>
+
+    <issueHandlers>
+        <PropertyNotSetInConstructor errorLevel="info" />
+        <PossiblyNullArrayOffset errorLevel="info" />
+        <MixedAssignment errorLevel="info" />
+        <MixedArgument errorLevel="info" />
+        <DocblockTypeContradiction errorLevel="info" />
+        <MixedInferredReturnType errorLevel="info" />
+        <MixedReturnStatement errorLevel="info" />
+        <PossiblyNullArgument errorLevel="info" />
+    </issueHandlers>
 </psalm>
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -15,12 +15,8 @@ final class Configuration implements ConfigurationInterface
     public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('odiseo_sylius_vendor_plugin');
-        if (\method_exists($treeBuilder, 'getRootNode')) {
-            $rootNode = $treeBuilder->getRootNode();
-        } else {
-            // BC layer for symfony/config 4.1 and older
-            $rootNode = $treeBuilder->root('odiseo_sylius_vendor_plugin');
-        }
+
+        $treeBuilder->getRootNode();
 
         return $treeBuilder;
     }

diff --git a/src/DependencyInjection/OdiseoSyliusVendorExtension.php b/src/DependencyInjection/OdiseoSyliusVendorExtension.php
@@ -4,22 +4,31 @@
 
 namespace Odiseo\SyliusVendorPlugin\DependencyInjection;
 
-use Sylius\Bundle\ResourceBundle\DependencyInjection\Extension\AbstractResourceExtension;
+use Symfony\Component\Config\Definition\ConfigurationInterface;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
 
-final class OdiseoSyliusVendorExtension extends AbstractResourceExtension
+final class OdiseoSyliusVendorExtension extends Extension
 {
     /**
      * {@inheritdoc}
      */
     public function load(array $config, ContainerBuilder $container): void
     {
-        $config = $this->processConfiguration($this->getConfiguration([], $container), $config);
+        $this->processConfiguration($this->getConfiguration([], $container), $config);
 
         $loader = new YamlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
 
         $loader->load('services.yaml');
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getConfiguration(array $config, ContainerBuilder $container): ConfigurationInterface
+    {
+        return new Configuration();
+    }
 }
diff --git a/src/Form/Type/VendorType.php b/src/Form/Type/VendorType.php
@@ -4,6 +4,7 @@
 
 namespace Odiseo\SyliusVendorPlugin\Form\Type;
 
+use Odiseo\SyliusVendorPlugin\Entity\VendorInterface;
 use Sylius\Bundle\ChannelBundle\Form\Type\ChannelChoiceType;
 use Sylius\Bundle\ResourceBundle\Form\Type\AbstractResourceType;
 use Sylius\Bundle\ResourceBundle\Form\Type\ResourceTranslationsType;
@@ -70,10 +71,11 @@ public function configureOptions(OptionsResolver $resolver): void
         parent::configureOptions($resolver);
 
         $resolver->setDefaults([
-            'validation_groups' => function (FormInterface $form) {
+            'validation_groups' => function (FormInterface $form): array {
+                /** @var VendorInterface|null $vendor */
                 $vendor = $form->getData();
 
-                if (!$vendor || null === $vendor->getId()) {
+                if (!$vendor instanceof VendorInterface || null === $vendor->getId()) {
                     return array_merge($this->validationGroups, ['odiseo_logo_create']);
                 }
 

diff --git a/src/Mapping/VendorAwareListener.php b/src/Mapping/VendorAwareListener.php
@@ -61,7 +61,7 @@ public function loadClassMetadata(LoadClassMetadataEventArgs $eventArgs): void
         $classMetadata = $eventArgs->getClassMetadata();
         $reflection = $classMetadata->reflClass;
 
-        if (!$reflection instanceof \ReflectionClass || $reflection->isAbstract()) {
+        if ($reflection->isAbstract()) {
             return;
         }
 

diff --git a/src/Repository/VendorRepository.php b/src/Repository/VendorRepository.php
@@ -21,7 +21,7 @@ public function findByEnabledQueryBuilder(?ChannelInterface $channel): QueryBuil
             ->setParameter('enabled', true)
         ;
 
-        if ($channel) {
+        if ($channel instanceof ChannelInterface) {
             $queryBuilder->innerJoin('v.channels', 'channel')
                 ->andWhere('channel = :channel')
                 ->setParameter('channel', $channel)

diff --git a/src/SitemapProvider/VendorUrlProvider.php b/src/SitemapProvider/VendorUrlProvider.php
@@ -80,7 +80,7 @@ public function generate(): iterable
      */
     private function getTranslations(VendorInterface $vendor): Collection
     {
-        return $vendor->getTranslations()->filter(function (TranslationInterface $translation) {
+        return $vendor->getTranslations()->filter(function (TranslationInterface $translation): bool {
             return $this->localeInLocaleCodes($translation);
         });
     }
@@ -91,7 +91,7 @@ private function getTranslations(VendorInterface $vendor): Collection
      */
     private function localeInLocaleCodes(TranslationInterface $translation): bool
     {
-        return in_array($translation->getLocale(), $this->getLocaleCodes());
+        return in_array($translation->getLocale(), $this->getLocaleCodes(), true);
     }
 
     /**
@@ -113,7 +113,7 @@ private function getLocaleCodes(): array
         /** @var ChannelInterface $channel */
         $channel = $this->channelContext->getChannel();
 
-        return $channel->getLocales()->map(function (LocaleInterface $locale) {
+        return $channel->getLocales()->map(function (LocaleInterface $locale): ?string {
             return $locale->getCode();
         })->toArray();
     }