TractorCow\Fluent\Tests\Extension\FluentSiteTreeExtensionTest

Complexity

Total Complexity

19

Size/Duplication

Total Lines	261
Duplicated Lines	0 %

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	testFluentURLs()	0	14	1
B	provideURLTests()	0	36	1
A	testUpdateCMSFields()	0	9	1
A	testUpdateStatusFlagsInherited()	0	7	1
A	testUpdateStatusFlagsDrafted()	0	13	2
A	testGetLocaleInformation()	0	18	1
B	testUpdateCMSActionsDrafted()	0	27	4
B	testUpdateCMSActionsInherited()	0	27	4
A	testGetLocales()	0	15	1
A	testAddLocalePrefixToUrlSegment()	0	14	1
A	localePrefixUrlProvider()	0	6	1
A	setUp()	0	13	1

<?php

namespace TractorCow\Fluent\Tests\Extension;

use Page;

The type Page was not found. Maybe you did not declare it correctly or list all dependencies?

use SilverStripe\CMS\Forms\SiteTreeURLSegmentField;
use SilverStripe\CMS\Model\SiteTree;
use SilverStripe\Control\Director;
use SilverStripe\Core\Config\Config;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\Forms\FieldList;
use SilverStripe\ORM\ArrayList;
use SilverStripe\View\ArrayData;
use TractorCow\Fluent\Extension\FluentDirectorExtension;
use TractorCow\Fluent\Extension\FluentSiteTreeExtension;
use TractorCow\Fluent\Model\Domain;
use TractorCow\Fluent\Model\Locale;
use TractorCow\Fluent\State\FluentState;

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();
        FluentState::singleton()
            ->setLocale('de_DE')
            ->setIsDomainMode(false);
    }

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

        $this->assertInstanceOf(ArrayData::class, $result);
        $this->assertEquals([
            'Locale' => 'en_NZ',
            'LocaleRFC1766' => 'en-NZ',
            'Title' => 'English (New Zealand)',
            'LanguageNative' => 'English',
            'Language' => 'en',
            'Link' => '/newzealand/a-page/',
            'AbsoluteLink' => 'http://mocked/newzealand/a-page/',
            'LinkingMode' => 'link',
            'URLSegment' => 'newzealand'
        ], $result->toMap());
    }

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

        $this->assertInstanceOf(ArrayList::class, $result);
        $this->assertCount(5, $result);
        $this->assertListEquals([
            ['Locale' => 'en_NZ'],
            ['Locale' => 'de_DE'],
            ['Locale' => 'en_US'],
            ['Locale' => 'es_ES'],
            ['Locale' => 'zh_CN'],
        ], $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', '/'],
            [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', '/'],
            ['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($domain, $locale, $prefixDisabled, $pageName, $url)
    {
        // Set state
        FluentState::singleton()
            ->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', $pageName);
        $this->assertEquals($url, $page->Link());

The method Link() does not exist on TractorCow\Fluent\Extension\FluentSiteTreeExtension.

    }

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

The method getStatusFlags() does not exist on TractorCow\Fluent\Extension\FluentSiteTreeExtension.

        $this->assertTrue(array_key_exists('fluentinherited', $flags));
    }

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

        $this->assertTrue(array_key_exists('modified', $flags));

        if (!array_key_exists('modified', $flags)) {
            return;
        }

        $this->assertEquals('Locale drafted', $flags['modified']['text']);
    }

    public function testUpdateCMSFields()
    {
        /** @var Page|FluentSiteTreeExtension $page */
        $page = $this->objFromFixture('Page', 'home');
        $fields = new FieldList();

        $page->updateCMSFields($fields);

        $this->assertNotNull($fields->fieldByName('LocaleStatusMessage'));
    }

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

The method getCMSActions() does not exist on TractorCow\Fluent\Extension\FluentSiteTreeExtension.

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

        $this->assertNotNull($majorActions);

        if ($majorActions === null) {
            return;
        }

        $actionSave = $majorActions->getChildren()->fieldByName('action_save');
        $actionPublish = $majorActions->getChildren()->fieldByName('action_publish');

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

        if ($actionSave === null || $actionPublish === null) {
            return;
        }

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

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

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

        $this->assertNotNull($majorActions);

        if ($majorActions === null) {
            return;
        }

        $actionSave = $majorActions->getChildren()->fieldByName('action_save');
        $actionPublish = $majorActions->getChildren()->fieldByName('action_publish');

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

        if ($actionSave === null || $actionPublish === null) {
            return;
        }

        $this->assertEquals('Saved', $actionSave->Title());
        $this->assertEquals('Save & publish', $actionPublish->Title());
    }

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

        /** @var FieldList $fields */
        $fields = $this->objFromFixture(Page::class, $fixture)->getCMSFields();

        /** @var SiteTreeURLSegmentField $segmentField */
        $segmentField = $fields->fieldByName('Root.Main.URLSegment');
        $this->assertInstanceOf(SiteTreeURLSegmentField::class, $segmentField);

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

    /**
     * @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_withalias_and_parent_page' => ['de_DE', 'staff', 'http://www.example.de/german/about-us/'],
        ];
    }
}