Merge pull request #172 from BitBagCommerce/dev

Prepare 2.0.0 release

UPGRADE.md

@@ -1,4 +1,18 @@
-# UPGRADE FROM 1.2.1/1.1.1 to 1.2.2-dev
+# UPGRADE FROM 1.0 TO 2.0
+
+* Media type field has been removed. For image blocks, use the [media](doc/medias.md) with image type. For HTML blocks,
+use raw content in [WYSIWYG editor](doc/wysiwyg.md)
+* Chanel awareness has been added to pages, blocks, FAQs, sections and media. That being said, many
+repository methods changed their signatures. In case you customized them in your src, check 
+new signatures in interfaces under [BitBag\SyliusCmsPlugin\Repository](src/Repository) namespace
+* WYSIWYG editor has been introduced. You will need to import it in your AppKernel and install 
+its assets. For more, check the [installation guide](doc/installation.md)
+* Sitemap support was added, you will need to enable extra bundle in your AppKernel. Read more
+in the [sitemap documentation](doc/sitemap.md)
+* Because of the possibility to [nest CMS Twig functions in the admin backend](doc/twig-functions-in-admin.md), in order to render block and page content
+you are now supposed to use `bitbag_cms_render_content` Twig function
+
+# UPGRADE FROM 1.2.1/1.1.1 to 1.2.2
 
 * `bitbag_render_block` has been renamed to `bitbag_cms_render_block`.
 * Database tables has been prefixed with `bitbag_cms` instead of `bitbag_sylius_cms_plugin` for backward compatibility and simplicity.

spec/Entity/PageSpec.php

@@ -13,7 +13,7 @@
 namespace spec\BitBag\SyliusCmsPlugin\Entity;
 
 use BitBag\SyliusCmsPlugin\Entity\Page;
-use BitBag\SyliusCmsPlugin\Entity\PageContentInterface;
+use BitBag\SyliusCmsPlugin\Entity\PageInterface;
 use BitBag\SyliusCmsPlugin\Entity\SectionInterface;
 use PhpSpec\ObjectBehavior;
 use Sylius\Component\Core\Model\ChannelInterface;
@@ -34,7 +34,7 @@ function it_is_a_resource(): void
 
     function it_implements_page_interface(): void
     {
-        $this->shouldHaveType(PageContentInterface::class);
+        $this->shouldHaveType(PageInterface::class);
     }
 
     function it_allows_access_via_properties(): void

spec/EventListener/PageImageUploadListenerSpec.php

@@ -13,7 +13,7 @@
 namespace spec\BitBag\SyliusCmsPlugin\EventListener;
 
 use BitBag\SyliusCmsPlugin\Entity\PageImageInterface;
-use BitBag\SyliusCmsPlugin\Entity\PageContentInterface;
+use BitBag\SyliusCmsPlugin\Entity\PageInterface;
 use BitBag\SyliusCmsPlugin\Entity\PageTranslationInterface;
 use BitBag\SyliusCmsPlugin\EventListener\PageImageUploadListener;
 use Doctrine\Common\Collections\ArrayCollection;
@@ -36,7 +36,7 @@ function it_is_initializable(): void
 
     function it_does_not_upload_if_not_page_instance(
         ResourceControllerEvent $event,
-        PageContentInterface $page
+        PageInterface $page
     ): void {
         $event->getSubject()->willReturn(Argument::any());
 
@@ -45,7 +45,7 @@ function it_does_not_upload_if_not_page_instance(
 
     function it_upload_image_for_each_translations(
         ResourceControllerEvent $event,
-        PageContentInterface $page,
+        PageInterface $page,
         PageTranslationInterface $pageTranslation,
         PageImageInterface $pageImage,
         ImageUploaderInterface $pageImageUploader

spec/Resolver/PageResourceResolverSpec.php

@@ -12,7 +12,7 @@
 
 namespace spec\BitBag\SyliusCmsPlugin\Resolver;
 
-use BitBag\SyliusCmsPlugin\Entity\PageContentInterface;
+use BitBag\SyliusCmsPlugin\Entity\PageInterface;
 use BitBag\SyliusCmsPlugin\Repository\PageRepositoryInterface;
 use BitBag\SyliusCmsPlugin\Resolver\PageResourceResolver;
 use BitBag\SyliusCmsPlugin\Resolver\PageResourceResolverInterface;
@@ -59,7 +59,7 @@ function it_logs_warning_if_page_was_not_found(
     function it_returns_page_if_found_in_database(
         PageRepositoryInterface $pageRepository,
         LocaleContextInterface $localeContext,
-        PageContentInterface $page
+        PageInterface $page
     ) {
         $localeContext->getLocaleCode()->willReturn('en_US');
         $pageRepository->findOneEnabledByCode('homepage_banner', 'en_US')->willReturn($page);

spec/Twig/Extension/RenderProductPagesExtensionSpec.php

@@ -12,7 +12,7 @@
 
 namespace spec\BitBag\SyliusCmsPlugin\Twig\Extension;
 
-use BitBag\SyliusCmsPlugin\Entity\PageContentInterface;
+use BitBag\SyliusCmsPlugin\Entity\PageInterface;
 use BitBag\SyliusCmsPlugin\Entity\SectionInterface;
 use BitBag\SyliusCmsPlugin\Repository\PageRepositoryInterface;
 use BitBag\SyliusCmsPlugin\Twig\Extension\RenderProductPagesExtension;
@@ -59,7 +59,7 @@ function it_renders_product_pages(
         ProductInterface $product,
         ChannelInterface $channel,
         PageRepositoryInterface $pageRepository,
-        PageContentInterface $page,
+        PageInterface $page,
         SectionInterface $section,
         EngineInterface $templatingEngine
     ): void {

src/Controller/MediaController.php

@@ -51,7 +51,6 @@ public function downloadMediaAction(Request $request): Response
 
         $code = $request->get('code');
         $mediaResourceResolver = $this->get('bitbag_sylius_cms_plugin.resolver.media_resource');
-
         /** @var MediaInterface $media */
         $media = $mediaResourceResolver->findOrLog($code);
 

src/Controller/PageController.php

@@ -12,7 +12,7 @@
 
 namespace BitBag\SyliusCmsPlugin\Controller;
 
-use BitBag\SyliusCmsPlugin\Entity\PageContentInterface;
+use BitBag\SyliusCmsPlugin\Entity\PageInterface;
 use FOS\RestBundle\View\View;
 use Sylius\Bundle\ResourceBundle\Controller\ResourceController;
 use Sylius\Component\Resource\ResourceActions;
@@ -67,7 +67,7 @@ public function previewAction(Request $request): Response
 
         $form->handleRequest($request);
 
-        /** @var PageContentInterface $newResource */
+        /** @var PageInterface $newResource */
         $newResource = $form->getData();
 
         $defaultLocale = $this->getParameter('locale');

src/Entity/Page.php

@@ -18,7 +18,7 @@
 use Sylius\Component\Resource\Model\TranslatableTrait;
 use Sylius\Component\Resource\Model\TranslationInterface;
 
-class Page implements PageContentInterface
+class Page implements PageInterface
 {
     use ToggleableTrait;
     use ProductsAwareTrait;

src/Entity/PageContentInterface.php → src/Entity/PageInterface.php

@@ -18,7 +18,7 @@
 use Sylius\Component\Resource\Model\ToggleableInterface;
 use Sylius\Component\Resource\Model\TranslatableInterface;
 
-interface PageContentInterface extends
+interface PageInterface extends
     ResourceInterface,
     TranslatableInterface,
     ToggleableInterface,

src/EventListener/PageImageUploadListener.php

@@ -12,7 +12,7 @@
 
 namespace BitBag\SyliusCmsPlugin\EventListener;
 
-use BitBag\SyliusCmsPlugin\Entity\PageContentInterface;
+use BitBag\SyliusCmsPlugin\Entity\PageInterface;
 use BitBag\SyliusCmsPlugin\Entity\PageTranslationInterface;
 use Sylius\Bundle\ResourceBundle\Event\ResourceControllerEvent;
 use Sylius\Component\Core\Uploader\ImageUploaderInterface;
@@ -32,7 +32,7 @@ public function uploadImage(ResourceControllerEvent $event): void
     {
         $page = $event->getSubject();
 
-        Assert::isInstanceOf($page, PageContentInterface::class);
+        Assert::isInstanceOf($page, PageInterface::class);
 
         /** @var PageTranslationInterface $translation */
         foreach ($page->getTranslations() as $translation) {

src/Fixture/Factory/BlockFixtureFactory.php

@@ -15,7 +15,6 @@
 use BitBag\SyliusCmsPlugin\Entity\BlockInterface;
 use BitBag\SyliusCmsPlugin\Entity\BlockTranslationInterface;
 use BitBag\SyliusCmsPlugin\Entity\SectionInterface;
-use BitBag\SyliusCmsPlugin\Factory\BlockFactoryInterface;
 use BitBag\SyliusCmsPlugin\Repository\BlockRepositoryInterface;
 use BitBag\SyliusCmsPlugin\Repository\SectionRepositoryInterface;
 use Sylius\Component\Channel\Context\ChannelContextInterface;
@@ -25,7 +24,7 @@
 
 final class BlockFixtureFactory implements FixtureFactoryInterface
 {
-    /** @var BlockFactoryInterface */
+    /** @var FactoryInterface */
     private $blockFactory;
 
     /** @var FactoryInterface */
@@ -47,7 +46,7 @@ final class BlockFixtureFactory implements FixtureFactoryInterface
     private $localeContext;
 
     public function __construct(
-        BlockFactoryInterface $blockFactory,
+        FactoryInterface $blockFactory,
         FactoryInterface $blockTranslationFactory,
         BlockRepositoryInterface $blockRepository,
         SectionRepositoryInterface $sectionRepository,

src/Fixture/Factory/MediaFixtureFactory.php

@@ -16,8 +16,10 @@
 use BitBag\SyliusCmsPlugin\Assigner\SectionsAssignerInterface;
 use BitBag\SyliusCmsPlugin\Entity\MediaInterface;
 use BitBag\SyliusCmsPlugin\Entity\MediaTranslationInterface;
+use BitBag\SyliusCmsPlugin\MediaProvider\ProviderInterface;
 use BitBag\SyliusCmsPlugin\Repository\MediaRepositoryInterface;
 use Sylius\Component\Resource\Factory\FactoryInterface;
+use Symfony\Component\HttpFoundation\File\File;
 
 final class MediaFixtureFactory implements FixtureFactoryInterface
 {
@@ -27,6 +29,9 @@ final class MediaFixtureFactory implements FixtureFactoryInterface
     /** @var FactoryInterface */
     private $mediaTranslationFactory;
 
+    /** @var ProviderInterface */
+    private $imageProvider;
+
     /** @var MediaRepositoryInterface */
     private $mediaRepository;
 
@@ -39,12 +44,14 @@ final class MediaFixtureFactory implements FixtureFactoryInterface
     public function __construct(
         FactoryInterface $mediaFactory,
         FactoryInterface $mediaTranslationFactory,
+        ProviderInterface $imageProvider,
         MediaRepositoryInterface $mediaRepository,
         ProductsAssignerInterface $productsAssigner,
         SectionsAssignerInterface $sectionsAssigner
     ) {
         $this->mediaFactory = $mediaFactory;
         $this->mediaTranslationFactory = $mediaTranslationFactory;
+        $this->imageProvider = $imageProvider;
         $this->mediaRepository = $mediaRepository;
         $this->productsAssigner = $productsAssigner;
         $this->sectionsAssigner = $sectionsAssigner;
@@ -77,6 +84,9 @@ private function createMedia(string $code, array $mediaData): void
         $media->setType($mediaData['type']);
         $media->setCode($code);
         $media->setEnabled($mediaData['enabled']);
+        $media->setFile(new File($mediaData['path']));
+
+        $this->imageProvider->upload($media);
 
         foreach ($mediaData['translations'] as $localeCode => $translation) {
             /** @var MediaTranslationInterface $mediaTranslation */

src/Fixture/Factory/PageFixtureFactory.php

@@ -12,7 +12,7 @@
 
 namespace BitBag\SyliusCmsPlugin\Fixture\Factory;
 
-use BitBag\SyliusCmsPlugin\Entity\PageContentInterface;
+use BitBag\SyliusCmsPlugin\Entity\PageInterface;
 use BitBag\SyliusCmsPlugin\Entity\PageImage;
 use BitBag\SyliusCmsPlugin\Entity\PageTranslationInterface;
 use BitBag\SyliusCmsPlugin\Entity\SectionInterface;
@@ -93,7 +93,7 @@ public function load(array $data): void
 
     private function createPage(string $code, array $pageData, bool $generateSlug = false): void
     {
-        /** @var PageContentInterface $page */
+        /** @var PageInterface $page */
         $page = $this->pageFactory->createNew();
         $products = $pageData['products'];
 
@@ -136,7 +136,7 @@ private function createPage(string $code, array $pageData, bool $generateSlug =
         $this->pageRepository->add($page);
     }
 
-    private function resolveProducts(PageContentInterface $page, int $limit): void
+    private function resolveProducts(PageInterface $page, int $limit): void
     {
         $products = $this->productRepository->findLatestByChannel(
             $this->channelContext->getChannel(),
@@ -149,7 +149,7 @@ private function resolveProducts(PageContentInterface $page, int $limit): void
         }
     }
 
-    private function resolveSections(PageContentInterface $page, array $sections): void
+    private function resolveSections(PageInterface $page, array $sections): void
     {
         foreach ($sections as $sectionCode) {
             /** @var SectionInterface $section */

src/Fixture/MediaFixture.php

@@ -45,7 +45,6 @@ protected function configureOptionsNode(ArrayNodeDefinition $optionsNode): void
                         ->children()
                             ->booleanNode('remove_existing')->defaultTrue()->end()
                             ->integerNode('number')->defaultNull()->end()
-                            ->booleanNode('code')->isRequired()->cannotBeEmpty()->end()
                             ->scalarNode('type')->isRequired()->cannotBeEmpty()->end()
                             ->scalarNode('path')->isRequired()->cannotBeEmpty()->end()
                             ->booleanNode('enabled')->defaultTrue()->end()

src/Importer/PageImporter.php

@@ -13,7 +13,7 @@
 namespace BitBag\SyliusCmsPlugin\Importer;
 
 use BitBag\SyliusCmsPlugin\Downloader\ImageDownloaderInterface;
-use BitBag\SyliusCmsPlugin\Entity\PageContentInterface;
+use BitBag\SyliusCmsPlugin\Entity\PageInterface;
 use BitBag\SyliusCmsPlugin\Entity\PageImage;
 use BitBag\SyliusCmsPlugin\Entity\PageTranslationInterface;
 use BitBag\SyliusCmsPlugin\Resolver\ImporterChannelsResolverInterface;
@@ -86,7 +86,7 @@ public function import(array $row): void
         $code = $this->getColumnValue(self::CODE_COLUMN, $row);
         Assert::notNull($code);
 
-        /** @var PageContentInterface $page */
+        /** @var PageInterface $page */
         $page = $this->pageResourceResolver->getResource($code);
 
         $page->setCode($code);
@@ -125,7 +125,7 @@ public function getResourceCode(): string
         return 'page';
     }
 
-    private function resolveImage(PageContentInterface $page, string $url, string $locale): void
+    private function resolveImage(PageInterface $page, string $url, string $locale): void
     {
         /** @var PageTranslationInterface $pageTranslation */
         $pageTranslation = $page->getTranslation($locale);

src/Repository/PageRepository.php

@@ -12,7 +12,7 @@
 
 namespace BitBag\SyliusCmsPlugin\Repository;
 
-use BitBag\SyliusCmsPlugin\Entity\PageContentInterface;
+use BitBag\SyliusCmsPlugin\Entity\PageInterface;
 use Doctrine\ORM\QueryBuilder;
 use Sylius\Bundle\ResourceBundle\Doctrine\ORM\EntityRepository;
 use Sylius\Component\Core\Model\ProductInterface;
@@ -40,7 +40,7 @@ public function findEnabled(bool $enabled): array
         ;
     }
 
-    public function findOneEnabledByCode(string $code, ?string $localeCode): ?PageContentInterface
+    public function findOneEnabledByCode(string $code, ?string $localeCode): ?PageInterface
     {
         return $this->createQueryBuilder('o')
             ->leftJoin('o.translations', 'translation')
@@ -58,7 +58,7 @@ public function findOneEnabledBySlugAndChannelCode(
         string $slug,
         ?string $localeCode,
         string $channelCode
-    ): ?PageContentInterface {
+    ): ?PageInterface {
         return $this->createQueryBuilder('o')
             ->leftJoin('o.translations', 'translation')
             ->innerJoin('o.channels', 'channels')

src/Repository/PageRepositoryInterface.php

@@ -12,7 +12,7 @@
 
 namespace BitBag\SyliusCmsPlugin\Repository;
 
-use BitBag\SyliusCmsPlugin\Entity\PageContentInterface;
+use BitBag\SyliusCmsPlugin\Entity\PageInterface;
 use Doctrine\ORM\QueryBuilder;
 use Sylius\Component\Core\Model\ProductInterface;
 use Sylius\Component\Resource\Repository\RepositoryInterface;
@@ -23,13 +23,13 @@ public function createListQueryBuilder(string $locale): QueryBuilder;
 
     public function findEnabled(bool $enabled): array;
 
-    public function findOneEnabledByCode(string $code, ?string $localeCode): ?PageContentInterface;
+    public function findOneEnabledByCode(string $code, ?string $localeCode): ?PageInterface;
 
     public function findOneEnabledBySlugAndChannelCode(
         string $slug,
         ?string $localeCode,
         string $channelCode
-    ): ?PageContentInterface;
+    ): ?PageInterface;
 
     public function createShopListQueryBuilder(string $sectionCode, string $channelCode): QueryBuilder;
 

src/Resolver/PageResourceResolver.php

@@ -12,7 +12,7 @@
 
 namespace BitBag\SyliusCmsPlugin\Resolver;
 
-use BitBag\SyliusCmsPlugin\Entity\PageContentInterface;
+use BitBag\SyliusCmsPlugin\Entity\PageInterface;
 use BitBag\SyliusCmsPlugin\Repository\PageRepositoryInterface;
 use Psr\Log\LoggerInterface;
 use Sylius\Component\Locale\Context\LocaleContextInterface;
@@ -38,11 +38,11 @@ public function __construct(
         $this->logger = $logger;
     }
 
-    public function findOrLog(string $code): ?PageContentInterface
+    public function findOrLog(string $code): ?PageInterface
     {
         $page = $this->pageRepository->findOneEnabledByCode($code, $this->localeContext->getLocaleCode());
 
-        if (false === $page instanceof PageContentInterface) {
+        if (false === $page instanceof PageInterface) {
             $this->logger->warning(sprintf(
                 'Page with "%s" code was not found in the database.',
                 $code

src/Resolver/PageResourceResolverInterface.php

@@ -12,9 +12,9 @@
 
 namespace BitBag\SyliusCmsPlugin\Resolver;
 
-use BitBag\SyliusCmsPlugin\Entity\PageContentInterface;
+use BitBag\SyliusCmsPlugin\Entity\PageInterface;
 
 interface PageResourceResolverInterface
 {
-    public function findOrLog(string $code): ?PageContentInterface;
+    public function findOrLog(string $code): ?PageInterface;
 }