IntegerNet\GlobalCustomLayout\Test\Integration\PageFrontendControllerTest

Complexity

Total Complexity

16

Size/Duplication

Total Lines	148
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	1

13 Methods

Rating	Name	Duplication	Size	Complexity
A	setCustomUpdate()	0	8	1
A	testViewWithGlobalCustomUpdate()	0	5	1
A	containsUpdateHandle()	0	8	1
A	thenContainsGlobalUpdateHandle()	0	3	1
A	createPage()	0	7	1
A	whenPageViewed()	0	6	2
A	testViewWithDefaultCustomUpdate()	0	5	1
A	getPageId()	0	3	1
A	givenDefaultCustomUpdateSelected()	0	3	1
A	thenContainsDefaultUpdateHandle()	0	3	1
A	getPage()	0	6	3
A	givenGlobalCustomUpdateSelected()	0	3	1
A	setUp()	0	10	1

<?php
declare(strict_types=1);

namespace IntegerNet\GlobalCustomLayout\Test\Integration;

use IntegerNet\GlobalCustomLayout\Test\src\PageLayoutUpdateManager;
use Magento\Cms\Model\Page;
use Magento\Cms\Model\Page\CustomLayoutRepositoryInterface;
use Magento\Cms\Model\PageFactory;

The type Magento\Cms\Model\PageFactory was not found. Maybe you did not declare it correctly or list all dependencies?

use Magento\Cms\Model\ResourceModel\Page as PageResourceModel;

class PageFrontendControllerTest extends AbstractFrontendControllerTest
{
    /** @var string */
    const PAGE_ID_FROM_FIXTURE = 'page100';

    /** @var PageLayoutUpdateManager */
    protected $layoutManager;

    /** @var Page */
    protected $page;

    /** @var PageResourceModel $pageResource */
    protected $pageResource;

    /** @var pageFactory $pageFactory */
    protected $pageFactory;

    /** @var CustomLayoutRepositoryInterface $repository */
    protected $repository;

    protected function setUp()
    {
        parent::setUp();

        $this->layoutManager = $this->objectManager->get(PageLayoutUpdateManager::class);
        $this->pageResource = $this->objectManager->get(PageResourceModel::class);
        $this->pageFactory = $this->objectManager->get(PageFactory::class);
        $this->repository = $this->objectManager->create(
            CustomLayoutRepositoryInterface::class,
            ['manager' => $this->layoutManager]
        );
    }

    /**
     * Check that custom handles are applied when rendering a page.
     *
     * @return void
     * @magentoDataFixture Magento/Cms/_files/pages.php
     */
    public function testViewWithGlobalCustomUpdate(): void
    {
        $this->givenGlobalCustomUpdateSelected();
        $this->whenPageViewed();
        $this->thenContainsGlobalUpdateHandle();
    }

    /**
     * Check that custom handles are applied when rendering a page.
     *
     * @return void
     * @magentoDataFixture Magento/Cms/_files/pages.php
     */
    public function testViewWithDefaultCustomUpdate(): void
    {
        $this->givenDefaultCustomUpdateSelected();
        $this->whenPageViewed();
        $this->thenContainsDefaultUpdateHandle();
    }

    protected function givenGlobalCustomUpdateSelected()
    {
        $this->setCustomUpdate(self::GLOBAL_IDENTIFIER);
    }

    protected function givenDefaultCustomUpdateSelected()
    {
        $this->setCustomUpdate($this->getPageId());
    }

    /**
     * Viewing the product
     *
     * @param int|null $pageId
     */
    protected function whenPageViewed(?int $pageId = null): void
    {
        if (!$pageId) {

The expression $pageId of type integer|null is loosely compared to false; this is ambiguous if the integer can be 0. You might want to explicitly use === null instead.

            $pageId = $this->getPageId();
        }
        $this->dispatch("/cms/page/view/page_id/{$pageId}");
    }

    protected function thenContainsGlobalUpdateHandle()
    {
        $this->containsUpdateHandle(self::GLOBAL_IDENTIFIER);
    }

    protected function thenContainsDefaultUpdateHandle()
    {
        $this->containsUpdateHandle(self::PAGE_ID_FROM_FIXTURE);
    }

    /**
     * Layout handles must contain the file.
     *
     * @param int|string $identifier
     * @param string $fileName
     */
    protected function containsUpdateHandle(
        $identifier = self::GLOBAL_IDENTIFIER,
        string $fileName = self::TEST_FILE)
    {
        $expectedHandle = "cms_page_view_selectable_{$identifier}_{$fileName}";

        $handles = $this->layoutInterface->getUpdate()->getHandles();
        $this->assertContains($expectedHandle, $handles);
    }

    protected function setCustomUpdate(int $forPageId, string $fileName = self::TEST_FILE)
    {
        $page = $this->getPage();

        $this->layoutManager->setFakeFiles($forPageId, [$fileName]);

        $page->setData('layout_update_selected', $fileName);
        $this->pageResource->save($page);
    }

    /**
     * @param string $pageIdentifier
     * @return Page
     */
    protected function createPage(?string $pageIdentifier = self::PAGE_ID_FROM_FIXTURE): Page
    {
        $page = $this->pageFactory->create(['customLayoutRepository' => $this->repository]);
        $page->setStoreId(self::STORE_ID);
        $page->load($pageIdentifier, Page::IDENTIFIER);

        return $page;
    }

    /**
     * @return Page
     */
    protected function getPage(): Page
    {
        if (!$this->page || !$this->page->getId()) {
            $this->page = $this->createPage();
        }
        return $this->page;
    }

    /**
     * @return int
     */
    private function getPageId(): int
    {
        return (int)$this->getPage()->getId();
    }
}