FluentSiteTreeExtensionTest::testPageVisibilityWithFallback() - Code Metrics - Inspection of "Merge pull request #711 from tractorcow-farm/featu..." - tractorcow-farm/silverstripe-fluent - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 48aca5...a67d7c )

by Damian
created 2021-05-20 23:25 UTC
testPageVisibilityWithFallback() A

↳ Parent: FluentSiteTreeExtensionTest
Complexity

Conditions	1
Paths	1
Size

Total Lines	28
Code Lines	19
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	19
nc	1
nop	4
dl	0
loc	28
rs	9.6333
c	0
b	0
f	0
<?php

namespace TractorCow\Fluent\Tests\Extension;

use Page;
filter:
    dependency_paths: ["lib/*"]
use SilverStripe\CMS\Forms\SiteTreeURLSegmentField;
filter:
    dependency_paths: ["lib/*"]
use SilverStripe\CMS\Model\SiteTree;
filter:
    dependency_paths: ["lib/*"]
use SilverStripe\Control\Director;
use SilverStripe\Core\Config\Config;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\Forms\CompositeField;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\LiteralField;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\ValidationException;
use SilverStripe\Versioned\Versioned;
use TractorCow\Fluent\Extension\FluentDirectorExtension;
use TractorCow\Fluent\Extension\FluentExtension;
use TractorCow\Fluent\Extension\FluentSiteTreeExtension;
use TractorCow\Fluent\Extension\FluentVersionedExtension;
use TractorCow\Fluent\Model\Domain;
use TractorCow\Fluent\Model\Locale;
use TractorCow\Fluent\Model\RecordLocale;
use TractorCow\Fluent\State\FluentState;

// Skip if pages module not installed
if (!class_exists(SiteTree::class)) {
    return;
}

class FluentSiteTreeExtensionTest extends SapphireTest
{
    protected static $fixture_file = 'FluentSiteTreeExtensionTest.yml';

    protected static $required_extensions = [
        SiteTree::class => [
            FluentSiteTreeExtension::class,
        ],
    ];

    protected function setUp()
    {
        parent::setUp();
        Config::modify()
            ->set(Director::class, 'alternate_base_url', 'http://mocked')
            ->set(FluentDirectorExtension::class, 'disable_default_prefix', false);

        // Clear cache
        Locale::clearCached();
        Domain::clearCached();
        (new FluentVersionedExtension)->flushCache();

        FluentState::singleton()
            ->setLocale('de_DE')
            ->setIsDomainMode(false);
    }

    public function testGetLocaleInformation()
    {
        FluentState::singleton()->withState(function (FluentState $newState) {
            $newState
                ->setLocale('de_DE')
                ->setIsDomainMode(false);

            /** @var Page|FluentSiteTreeExtension $page */
            $page = $this->objFromFixture(Page::class, 'nz-page');
            $result = $page->LocaleInformation('en_NZ');

            $this->assertInstanceOf(RecordLocale::class, $result);
            $this->assertEquals('en_NZ', $result->getLocale());
            $this->assertEquals('en-nz', $result->getLocaleRFC1766());
            $this->assertEquals('en-nz', $result->getHrefLang());
            $this->assertEquals('English (New Zealand)', $result->getTitle());
            $this->assertEquals('English', $result->getLanguageNative());
            $this->assertEquals('en', $result->getLanguage());
            $this->assertEquals('/newzealand/a-page/', $result->getLink());
            $this->assertEquals('http://mocked/newzealand/a-page/', $result->getAbsoluteLink());
            $this->assertEquals('link', $result->getLinkingMode());
            $this->assertEquals('newzealand', $result->getURLSegment());
        });
    }

    public function testGetLocales()
    {
        FluentState::singleton()->withState(function (FluentState $newState) {
            $newState
                ->setLocale('de_DE')
                ->setIsDomainMode(false);

            /** @var Page|FluentSiteTreeExtension $page */
            $page = $this->objFromFixture(Page::class, 'nz-page');
            $result = $page->Locales();

            $this->assertInstanceOf(ArrayList::class, $result);
            $this->assertCount(6, $result);
            $this->assertListEquals([
                ['Locale' => 'en_NZ'],
                ['Locale' => 'de_DE'],
                ['Locale' => 'en_US'],
                ['Locale' => 'en_GB'],
                ['Locale' => 'es_ES'],
                ['Locale' => 'zh_CN'],
            ], $result);
            ], /** @scrutinizer ignore-type */ $result);
        });
    }

    /**
     * Tests for url generation
     *
     * @return array list of tests with values:
     *  - domain (or false for non-domain mode)
     *  - locale
     *  - disable_default_prefix flag
     *  - page id
     *  - expected link
     */
    public function provideURLTests()
    {
        return [
            // Non-domain tests
            [null, 'de_DE', false, 'home', '/german/'],
            [null, 'de_DE', false, 'about', '/german/about-us/'],
            [null, 'de_DE', false, 'staff', '/german/about-us/my-staff/'],
            // Since de_DE is the only locale on the www.example.de domain, ensure that the locale
            // isn't unnecessarily added to the link.
            // In this case disable_default_prefix is ignored
            // See https://github.com/tractorcow/silverstripe-fluent/issues/75
            ['www.example.de', 'de_DE', false, 'home', '/'],
            ['www.example.de', 'de_DE', false, 'about', '/about-us/'],
            ['www.example.de', 'de_DE', false, 'staff', '/about-us/my-staff/'],

            // Test domains with multiple locales
            //  - es_ES non default locale
            ['www.example.com', 'es_ES', false, 'home', '/es_ES/'],
            ['www.example.com', 'es_ES', false, 'about', '/es_ES/about-us/'],
            ['www.example.com', 'es_ES', false, 'staff', '/es_ES/about-us/my-staff/'],
            //  - en_US default locale
            ['www.example.com', 'en_US', false, 'home', '/usa/'],
            ['www.example.com', 'en_US', false, 'about', '/usa/about-us/'],
            ['www.example.com', 'en_US', false, 'staff', '/usa/about-us/my-staff/'],
            //  - en_US default locale, but with disable_default_prefix on
            ['www.example.com', 'en_US', true, 'home', '/'],
            ['www.example.com', 'en_US', true, 'about', '/about-us/'],
            ['www.example.com', 'en_US', true, 'staff', '/about-us/my-staff/'],

            // Test cross-domain links include the opposing domain
            // - to default locale
            ['www.example.de', 'en_US', true, 'home', 'http://www.example.com/'],
            ['www.example.de', 'en_US', true, 'staff', 'http://www.example.com/about-us/my-staff/'],
            // - to non defalut locale
            ['www.example.de', 'es_ES', true, 'home', 'http://www.example.com/es_ES/'],
            ['www.example.de', 'es_ES', true, 'staff', 'http://www.example.com/es_ES/about-us/my-staff/'],
        ];
    }

    /**
     * Test that URLS for pages are generated correctly
     *
     * @dataProvider provideURLTests
     * @param string $domain
     * @param string $locale
     * @param bool $prefixDisabled
     * @param string $pageName
     * @param string $url
     */
    public function testFluentURLs(?string $domain, string $locale, bool $prefixDisabled, string $pageName, string $url)
    {
        FluentState::singleton()->withState(
            function (FluentState $newState) use ($domain, $locale, $prefixDisabled, $pageName, $url) {
                $newState
                    ->setLocale($locale)
                    ->setDomain($domain)
                    ->setIsDomainMode(!empty($domain));

                // Set url generation option
                Config::modify()
                    ->set(FluentDirectorExtension::class, 'disable_default_prefix', $prefixDisabled);

                /** @var Page|FluentSiteTreeExtension $page */
                $page = $this->objFromFixture(Page::class, $pageName);
                $this->assertEquals($url, $page->Link());
                $this->assertEquals($url, $page->/** @scrutinizer ignore-call */ Link());
            }
        );
    }

    public function testUpdateStatusFlagsFluentInvisible()
    {
        /** @var Page|FluentSiteTreeExtension $page */
        $page = $this->objFromFixture(Page::class, 'home');
        $flags = $page->getStatusFlags();
        $flags = $page->getStatusFlags();

        $this->assertArrayHasKey('fluentinvisible', $flags);
    }

    public function testStatusMessageNotVisible()
    {
        FluentState::singleton()->withState(function (FluentState $newState) {
            $newState
                ->setLocale('en_NZ')
                ->setIsDomainMode(false);

            /** @var Page|FluentSiteTreeExtension $page */
            $page = $this->objFromFixture(Page::class, 'staff');
            $page->config()
                   config()
                ->set('locale_published_status_message', true)
                ->set('frontend_publish_required', FluentExtension::INHERITANCE_MODE_EXACT);

            $fields = $page->getCMSFields();
            $fields = $page->getCMSFields();

            /** @var LiteralField $statusMessage */
            $statusMessage = $fields->fieldByName('LocaleStatusMessage');

            $this->assertNotNull($statusMessage, 'Locale message was not added');
            $this->assertContains('This page will not be visible', $statusMessage->getContent());
        });
    }

    public function testStatusMessageUnknown()
    {
        FluentState::singleton()->withState(function (FluentState $newState) {
            $newState
                ->setLocale('en_NZ')
                ->setIsDomainMode(false);

            /** @var Page|FluentSiteTreeExtension $page */
            $page = $this->objFromFixture(Page::class, 'home');
            $page->config()
                ->set('locale_published_status_message', true)
                ->set('frontend_publish_required', FluentExtension::INHERITANCE_MODE_ANY);

            $fields = $page->getCMSFields();

            /** @var LiteralField $statusMessage */
            $statusMessage = $fields->fieldByName('LocaleStatusMessage');

            $this->assertNotNull($fields->fieldByName('LocaleStatusMessage'));
            $this->assertContains('No content is available for this page', $statusMessage->getContent());
        });
    }

    public function testStatusMessageDrafted()
    {
        FluentState::singleton()->withState(function (FluentState $newState) {
            $newState
                ->setLocale('en_NZ')
                ->setIsDomainMode(false);

            /** @var Page|FluentSiteTreeExtension $page */
            $page = $this->objFromFixture(Page::class, 'home');
            $page->config()
                ->set('locale_published_status_message', true)
                ->set('frontend_publish_required', FluentExtension::INHERITANCE_MODE_ANY);
            $page->write();
                   write();

            $fields = $page->getCMSFields();

            /** @var LiteralField $statusMessage */
            $statusMessage = $fields->fieldByName('LocaleStatusMessage');

            $this->assertNotNull($fields->fieldByName('LocaleStatusMessage'));
            $this->assertContains('A draft has been created for this locale', $statusMessage->getContent());
        });
    }

    public function testUpdateCMSActionsInherited()
    {
        /** @var Page|FluentSiteTreeExtension $page */
        $page = $this->objFromFixture(Page::class, 'home');
        $actions = $page->getCMSActions();
        $actions = $page->getCMSActions();

        /** @var CompositeField $majorActions */
        $majorActions = $actions->fieldByName('MajorActions');

        $this->assertNotNull($majorActions);

        $actionSave = $majorActions->getChildren()->fieldByName('action_save_localised_copy');
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        $actionPublish = $majorActions->getChildren()->fieldByName('action_publish_localised_copy');
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

        $this->assertNotNull($actionSave);
        $this->assertNotNull($actionPublish);

        $this->assertEquals('Copy to draft', $actionSave->Title());
        $this->assertEquals('Copy & publish', $actionPublish->Title());
    }

    public function testUpdateCMSActionsDrafted()
    {
        /** @var Page|FluentSiteTreeExtension $page */
        $page = $this->objFromFixture(Page::class, 'about');
        // Make sure page is properly localised (including version records)
        $page->writeToStage(Versioned::DRAFT);
               writeToStage(Versioned::DRAFT);
        $actions = $page->getCMSActions();

        /** @var CompositeField $majorActions */
        $majorActions = $actions->fieldByName('MajorActions');

        $this->assertNotNull($majorActions);

        $actionSave = $majorActions->getChildren()->fieldByName('action_save');
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        $actionPublish = $majorActions->getChildren()->fieldByName('action_publish');
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

        $this->assertNotNull($actionSave);
        $this->assertNotNull($actionPublish);

        $this->assertEquals('Saved', $actionSave->Title());
        // The default value changed between SS 4.0 and 4.1 - assert it contains Publish instead of exact matching
        $this->assertContains('publish', strtolower($actionPublish->Title()));
    }

    /**
     * @param string $localeCode
     * @param string $fixture
     * @param string $expected
     * @dataProvider localePrefixUrlProvider
     */
    public function testAddLocalePrefixToUrlSegment(string $localeCode, string $fixture, string $expected)
    {
        FluentState::singleton()->withState(
            function (FluentState $newState) use ($localeCode, $fixture, $expected) {
                $newState
                    ->setLocale($localeCode)
                    ->setIsDomainMode(true);

                $fields = $this->objFromFixture(Page::class, $fixture)->getCMSFields();

                /** @var SiteTreeURLSegmentField $segmentField */
                $segmentField = $fields->fieldByName('Root.Main.URLSegment');
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
                $this->assertInstanceOf(SiteTreeURLSegmentField::class, $segmentField);

                $this->assertSame($expected, $segmentField->getURLPrefix());
            }
        );
    }

    public function testHomeVisibleOnFrontendBothConfigAny()
    {
        Config::modify()->set(DataObject::class, 'cms_localisation_required', FluentExtension::INHERITANCE_MODE_ANY);
        Config::modify()->set(DataObject::class, 'frontend_publish_required', FluentExtension::INHERITANCE_MODE_ANY);

        FluentState::singleton()->withState(function (FluentState $newState) {
            $newState
                ->setLocale('de_DE')
                ->setIsDomainMode(false)
                ->setIsFrontend(true);

            $page = Page::get()->filter('URLSegment', 'home')->first();

            $this->assertNotNull($page);
        });
    }

    public function testHomeVisibleOnFrontendOneConfigAny()
    {
        Config::modify()->set(DataObject::class, 'cms_localisation_required', FluentExtension::INHERITANCE_MODE_EXACT);
        Config::modify()->set(DataObject::class, 'frontend_publish_required', FluentExtension::INHERITANCE_MODE_ANY);

        FluentState::singleton()->withState(function (FluentState $newState) {
            $newState
                ->setLocale('de_DE')
                ->setIsDomainMode(false)
                ->setIsFrontend(true);

            $page = Page::get()->filter('URLSegment', 'home')->first();

            $this->assertNotNull($page);
        });
    }

    public function testHomeNotVisibleOnFrontendBothConfigExact()
    {
        Config::modify()->set(DataObject::class, 'cms_localisation_required', FluentExtension::INHERITANCE_MODE_EXACT);
        Config::modify()->set(DataObject::class, 'frontend_publish_required', FluentExtension::INHERITANCE_MODE_EXACT);

        FluentState::singleton()->withState(function (FluentState $newState) {
            $newState
                ->setLocale('de_DE')
                ->setIsDomainMode(false)
                ->setIsFrontend(true);

            $page = Page::get()->filter('URLSegment', 'home')->first();

            $this->assertNull($page);
        });
    }

    public function testHomeNotVisibleOnFrontendOneConfigExact()
    {
        Config::modify()->set(DataObject::class, 'cms_localisation_required', FluentExtension::INHERITANCE_MODE_ANY);
        Config::modify()->set(DataObject::class, 'frontend_publish_required', FluentExtension::INHERITANCE_MODE_EXACT);

        FluentState::singleton()->withState(function (FluentState $newState) {
            $newState
                ->setLocale('de_DE')
                ->setIsDomainMode(false)
                ->setIsFrontend(true);

            $page = Page::get()->filter('URLSegment', 'home')->first();

            $this->assertNull($page);
        });
    }

    public function testHomeVisibleInCMSBothConfigAny()
    {
        Config::modify()->set(DataObject::class, 'cms_localisation_required', FluentExtension::INHERITANCE_MODE_ANY);
        Config::modify()->set(DataObject::class, 'frontend_publish_required', FluentExtension::INHERITANCE_MODE_ANY);

        FluentState::singleton()->withState(function (FluentState $newState) {
            $newState
                ->setLocale('de_DE')
                ->setIsDomainMode(false)
                ->setIsFrontend(false);

            $page = Page::get()->filter('URLSegment', 'home')->first();

            $this->assertNotNull($page);
        });
    }

    public function testHomeVisibleInCMSOneConfigAny()
    {
        Config::modify()->set(DataObject::class, 'cms_localisation_required', FluentExtension::INHERITANCE_MODE_ANY);
        Config::modify()->set(DataObject::class, 'frontend_publish_required', FluentExtension::INHERITANCE_MODE_EXACT);

        FluentState::singleton()->withState(function (FluentState $newState) {
            $newState
                ->setLocale('de_DE')
                ->setIsDomainMode(false)
                ->setIsFrontend(false);

            $page = Page::get()->filter('URLSegment', 'home')->first();

            $this->assertNotNull($page);
        });
    }

    public function testHomeNotVisibleInCMSBothConfigExact()
    {
        Config::modify()->set(DataObject::class, 'cms_localisation_required', FluentExtension::INHERITANCE_MODE_EXACT);
        Config::modify()->set(DataObject::class, 'frontend_publish_required', FluentExtension::INHERITANCE_MODE_EXACT);

        FluentState::singleton()->withState(function (FluentState $newState) {
            $newState
                ->setLocale('de_DE')
                ->setIsDomainMode(false)
                ->setIsFrontend(false);

            $page = Page::get()->filter('URLSegment', 'home')->first();

            $this->assertNull($page);
        });
    }

    public function testHomeNotVisibleInCMSOneConfigExact()
    {
        Config::modify()->set(DataObject::class, 'cms_localisation_required', FluentExtension::INHERITANCE_MODE_EXACT);
        Config::modify()->set(DataObject::class, 'frontend_publish_required', FluentExtension::INHERITANCE_MODE_ANY);

        FluentState::singleton()->withState(function (FluentState $newState) {
            $newState
                ->setLocale('de_DE')
                ->setIsDomainMode(false)
                ->setIsFrontend(false);

            $page = Page::get()->filter('URLSegment', 'home')->first();

            $this->assertNull($page);
        });
    }

    /**
     * @return array[]
     */
    public function localePrefixUrlProvider()
    {
        return [
            'locale_with_domain'            => ['en_US', 'about', 'http://www.example.com/usa/'],
            'locale_without_domain'         => ['zh_CN', 'about', 'http://mocked/zh_CN/'],
            'locale_alone_on_domain_nested' => ['de_DE', 'staff', 'http://www.example.de/about-us/'],
        ];
    }

    /**
     * @param string|bool $cmsMode
     * @param string|bool $frontendMode
     * @param bool $isFrontend
     * @param int $expected
     * @throws ValidationException
     * @dataProvider localeFallbackProvider
     */
    public function testPageVisibilityWithFallback($cmsMode, $frontendMode, bool $isFrontend, int $expected)
    {
        Config::modify()
            ->set(DataObject::class, 'cms_localisation_required', $cmsMode)
            ->set(DataObject::class, 'frontend_publish_required', $frontendMode);

        $pageId = FluentState::singleton()->withState(function (FluentState $state): int {
            $state
                ->setLocale('en_NZ')
                ->setIsDomainMode(false);

            // Intentionally avoiding fixtures as this is easier to maintain
            $page = Page::create();
            $page->Title = 'fallback-test';
            $page->URLSegment = 'fallback-test';
            $page->write();
            $page->publishRecursive();

            return $page->ID;
        });

        FluentState::singleton()->withState(function (FluentState $state) use ($isFrontend, $pageId, $expected) {
            $state
                ->setLocale('en_GB')
                ->setIsDomainMode(false)
                ->setIsFrontend($isFrontend);

            $this->assertCount($expected, Page::get()->byIDs([$pageId]));
        });
    }

    public function localeFallbackProvider(): array
    {
        return [
            'Frontend / no inheritance' => [
                FluentExtension::INHERITANCE_MODE_EXACT,
                FluentExtension::INHERITANCE_MODE_EXACT,
                true,
                0,
            ],
            'Frontend / fallback inheritance' => [
                FluentExtension::INHERITANCE_MODE_EXACT,
                FluentExtension::INHERITANCE_MODE_FALLBACK,
                true,
                1,
            ],
            'Frontend / no inheritance (legacy)' => [
                true,
                true,
                true,
                0,
            ],
            'CMS / no inheritance' => [
                FluentExtension::INHERITANCE_MODE_EXACT,
                FluentExtension::INHERITANCE_MODE_EXACT,
                false,
                0,
            ],
            'CMS / fallback inheritance' => [
                FluentExtension::INHERITANCE_MODE_FALLBACK,
                FluentExtension::INHERITANCE_MODE_EXACT,
                false,
                1,
            ],
            'CMS / no inheritance (legacy)' => [
                true,
                true,
                false,
                0,
            ],
        ];
    }
}

tractorcow-farm / silverstripe-fluent

Push — master ( 48aca5...a67d7c )

testPageVisibilityWithFallback() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
