Merge pull request #330 from leszczuu/fix/silent-assigners

making assigners break with incorrect data

Author: leszczuu

.travis.yml

@@ -38,6 +38,7 @@ before_install:
 
 install:
     - composer require ${DEPENDENCY_VERSIONS} --no-update
+    - composer require stefandoorn/sitemap-plugin --no-update
     - composer update --no-interaction --prefer-dist
     - (cd tests/Application && yarn install)
 

composer.json

@@ -44,6 +44,9 @@
     "suggest": {
         "stefandoorn/sitemap-plugin": "^2.0@alpha"
     },
+    "suggest": {
+        "stefandoorn/sitemap-plugin": "Adds CMS pages & sections support to the Sylius sitemap plugin"
+    },
     "conflict": {
         "symfony/symfony": "4.1.8",
         "symfony/browser-kit": "4.1.8",

doc/installation.md

@@ -52,7 +52,6 @@ Import routing in your `config/routes.yaml` file:
 bitbag_sylius_cms_plugin:
     resource: "@BitBagSyliusCmsPlugin/Resources/config/routing.yml"
 ```
-
 If You have installed https://github.com/stefandoorn/sitemap-plugin according to its installation instructions
 import optional sitemap providers:
 ```yaml

src/Assigner/ChannelsAssigner.php

@@ -15,6 +15,7 @@
 use Sylius\Component\Channel\Model\ChannelsAwareInterface;
 use Sylius\Component\Channel\Repository\ChannelRepositoryInterface;
 use Sylius\Component\Core\Model\ChannelInterface;
+use Webmozart\Assert\Assert;
 
 final class ChannelsAssigner implements ChannelsAssignerInterface
 {
@@ -32,9 +33,8 @@ public function assign(ChannelsAwareInterface $channelsAware, array $channelsCod
             /** @var ChannelInterface $channel|null */
             $channel = $this->channelRepository->findOneBy(['code' => $channelCode]);
 
-            if (null !== $channel) {
-                $channelsAware->addChannel($channel);
-            }
+            Assert::notNull($channel, sprintf('Channel with %s code not found.', $channelCode));
+            $channelsAware->addChannel($channel);
         }
     }
 }

src/Assigner/ProductsAssigner.php

@@ -15,6 +15,7 @@
 use BitBag\SyliusCmsPlugin\Entity\ProductsAwareInterface;
 use Sylius\Component\Core\Model\ProductInterface;
 use Sylius\Component\Core\Repository\ProductRepositoryInterface;
+use Webmozart\Assert\Assert;
 
 final class ProductsAssigner implements ProductsAssignerInterface
 {
@@ -32,9 +33,8 @@ public function assign(ProductsAwareInterface $productsAware, array $productsCod
             /** @var ProductInterface $product */
             $product = $this->productRepository->findOneBy(['code' => $productCode]);
 
-            if (null !== $product) {
-                $productsAware->addProduct($product);
-            }
+            Assert::notNull($product, sprintf('Product with %s code not found.', $productCode));
+            $productsAware->addProduct($product);
         }
     }
 }

src/Assigner/SectionsAssigner.php

@@ -15,6 +15,7 @@
 use BitBag\SyliusCmsPlugin\Entity\SectionableInterface;
 use BitBag\SyliusCmsPlugin\Entity\SectionInterface;
 use BitBag\SyliusCmsPlugin\Repository\SectionRepositoryInterface;
+use Webmozart\Assert\Assert;
 
 final class SectionsAssigner implements SectionsAssignerInterface
 {
@@ -32,9 +33,8 @@ public function assign(SectionableInterface $sectionsAware, array $sectionsCodes
             /** @var SectionInterface $section */
             $section = $this->sectionRepository->findOneBy(['code' => $sectionCode]);
 
-            if (null !== $section) {
-                $sectionsAware->addSection($section);
-            }
+            Assert::notNull($section, sprintf('Section with %s code not found.', $sectionCode));
+            $sectionsAware->addSection($section);
         }
     }
 }

src/Assigner/TaxonsAssigner.php

@@ -15,6 +15,7 @@
 use BitBag\SyliusCmsPlugin\Entity\TaxonAwareInterface;
 use Sylius\Component\Core\Model\TaxonInterface;
 use Sylius\Component\Taxonomy\Repository\TaxonRepositoryInterface;
+use Webmozart\Assert\Assert;
 
 final class TaxonsAssigner implements TaxonsAssignerInterface
 {
@@ -32,9 +33,8 @@ public function assign(TaxonAwareInterface $taxonAware, array $taxonCodes): void
             /** @var TaxonInterface $taxon */
             $taxon = $this->taxonRepository->findOneBy(['code' => $taxonCode]);
 
-            if (null !== $taxon) {
-                $taxonAware->addTaxon($taxon);
-            }
+            Assert::notNull($taxon, sprintf('Taxon with %s code not found.', $taxonCode));
+            $taxonAware->addTaxon($taxon);
         }
     }
 }