ThemeResolverTest::customThemeDefinitionsAreRespectedProvider() - Code Metrics - Inspection of "Merge branch '2.3'" - silverstripe/silverstripe-subsites - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( e73d62...b32499 )

by Robbie

created 2019-09-25 22:01 UTC

customThemeDefinitionsAreRespectedProvider() A

↳ Parent: ThemeResolverTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	58
Code Lines	37

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	37
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	58
rs	9.328

How to fix Long Method

<?php

namespace SilverStripe\Subsites\Tests\Service;

use SilverStripe\Core\Config\Config;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\Subsites\Model\Subsite;
use SilverStripe\Subsites\Service\ThemeResolver;
use SilverStripe\View\SSViewer;

class ThemeResolverTest extends SapphireTest
{
    protected $themeList = [
        '$public',
        'custom',
        'main',
        'backup',
        SSViewer::DEFAULT_THEME,
    ];

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

        // Setup known theme config
        Config::modify()->set(SSViewer::class, 'themes', $this->themeList);
    }

    public function testSubsiteWithoutThemeReturnsDefaultThemeList()
    {
        $subsite = new Subsite();
        $resolver = new ThemeResolver();

        $this->assertSame($this->themeList, $resolver->getThemeList($subsite));
    }

    public function testSubsiteWithCustomThemePrependsToList()
    {
        $subsite = new Subsite();
        $subsite->Theme = 'subsite';


        $resolver = new ThemeResolver();

        $expected = array_merge(['subsite'], $this->themeList);

        $this->assertSame($expected, $resolver->getThemeList($subsite));
    }

    public function testSubsiteWithCustomThemeDoesNotCascadeUpTheList()
    {
        $subsite = new Subsite();
        $subsite->Theme = 'main';


        $resolver = new ThemeResolver();

        $expected = [
            'main', // 'main' is moved to the top
            '$public', // $public is preserved
            // Anything above 'main' is removed
            'backup',
            SSViewer::DEFAULT_THEME,
        ];

        $this->assertSame($expected, $resolver->getThemeList($subsite));
    }

    /**
     * @dataProvider customThemeDefinitionsAreRespectedProvider
     */
    public function testCustomThemeDefinitionsAreRespected($themeOptions, $siteTheme, $expected)
    {
        Config::modify()->set(ThemeResolver::class, 'theme_options', $themeOptions);

        $subsite = new Subsite();
        $subsite->Theme = $siteTheme;


        $resolver = new ThemeResolver();

        $this->assertSame($expected, $resolver->getThemeList($subsite));
    }

    public function customThemeDefinitionsAreRespectedProvider()
    {
        return [
            // Simple
            [
                ['test' => $expected = [
                    'subsite',
                    'backup',
                    '$public',
                    SSViewer::DEFAULT_THEME,
                ]],
                'test',
                $expected
            ],
            // Many options
            [
                [
                    'aye' => [
                        'aye',
                        'thing',
                        SSViewer::DEFAULT_THEME,
                    ],
                    'bee' => $expected = [
                        'subsite',
                        'backup',
                        '$public',
                        SSViewer::DEFAULT_THEME,
                    ],
                    'sea' => [
                        'mer',
                        'ocean',
                        SSViewer::DEFAULT_THEME,
                    ],
                ],
                'bee',
                $expected
            ],
            // Conflicting with root definitions
            [
                ['main' => $expected = [
                    'subsite',
                    'backup',
                    '$public',
                    SSViewer::DEFAULT_THEME,
                ]],
                'main',
                $expected
            ],
            // Declaring a theme specifically should still work
            [
                ['test' => [
                    'subsite',
                    'backup',
                    '$public',
                    SSViewer::DEFAULT_THEME,
                ]],
                'other',
                array_merge(['other'], $this->themeList)
            ],
        ];
    }
}


1			<?php
2
3			namespace SilverStripe\Subsites\Tests\Service;
4
5			use SilverStripe\Core\Config\Config;
6			use SilverStripe\Dev\SapphireTest;
7			use SilverStripe\Subsites\Model\Subsite;
8			use SilverStripe\Subsites\Service\ThemeResolver;
9			use SilverStripe\View\SSViewer;
10
11			class ThemeResolverTest extends SapphireTest
12			{
13			protected $themeList = [
14			'$public',
15			'custom',
16			'main',
17			'backup',
18			SSViewer::DEFAULT_THEME,
19			];
20
21			protected function setUp()
22			{
23			parent::setUp();
24
25			// Setup known theme config
26			Config::modify()->set(SSViewer::class, 'themes', $this->themeList);
27			}
28
29			public function testSubsiteWithoutThemeReturnsDefaultThemeList()
30			{
31			$subsite = new Subsite();
32			$resolver = new ThemeResolver();
33
34			$this->assertSame($this->themeList, $resolver->getThemeList($subsite));
35			}
36
37			public function testSubsiteWithCustomThemePrependsToList()
38			{
39			$subsite = new Subsite();
40			$subsite->Theme = 'subsite';
			0 ignored issues – show Bug Best Practice introduced 2019-09-25 22:05 UTC by Report Bug Copy Issue Report The property `Theme` does not exist on `SilverStripe\Subsites\Model\Subsite`. Since you implemented `__set`, consider adding a @property annotation. Loading history...
41
42			$resolver = new ThemeResolver();
43
44			$expected = array_merge(['subsite'], $this->themeList);
45
46			$this->assertSame($expected, $resolver->getThemeList($subsite));
47			}
48
49			public function testSubsiteWithCustomThemeDoesNotCascadeUpTheList()
50			{
51			$subsite = new Subsite();
52			$subsite->Theme = 'main';
			0 ignored issues – show Bug Best Practice introduced 2019-09-25 22:05 UTC by Report Bug Copy Issue Report The property `Theme` does not exist on `SilverStripe\Subsites\Model\Subsite`. Since you implemented `__set`, consider adding a @property annotation. Loading history...
53
54			$resolver = new ThemeResolver();
55
56			$expected = [
57			'main', // 'main' is moved to the top
58			'$public', // $public is preserved
59			// Anything above 'main' is removed
60			'backup',
61			SSViewer::DEFAULT_THEME,
62			];
63
64			$this->assertSame($expected, $resolver->getThemeList($subsite));
65			}
66
67			/**
68			* @dataProvider customThemeDefinitionsAreRespectedProvider
69			*/
70			public function testCustomThemeDefinitionsAreRespected($themeOptions, $siteTheme, $expected)
71			{
72			Config::modify()->set(ThemeResolver::class, 'theme_options', $themeOptions);
73
74			$subsite = new Subsite();
75			$subsite->Theme = $siteTheme;
			0 ignored issues – show Bug Best Practice introduced 2019-09-25 22:05 UTC by Report Bug Copy Issue Report The property `Theme` does not exist on `SilverStripe\Subsites\Model\Subsite`. Since you implemented `__set`, consider adding a @property annotation. Loading history...
76
77			$resolver = new ThemeResolver();
78
79			$this->assertSame($expected, $resolver->getThemeList($subsite));
80			}
81
82			public function customThemeDefinitionsAreRespectedProvider()
83			{
84			return [
85			// Simple
86			[
87			['test' => $expected = [
88			'subsite',
89			'backup',
90			'$public',
91			SSViewer::DEFAULT_THEME,
92			]],
93			'test',
94			$expected
95			],
96			// Many options
97			[
98			[
99			'aye' => [
100			'aye',
101			'thing',
102			SSViewer::DEFAULT_THEME,
103			],
104			'bee' => $expected = [
105			'subsite',
106			'backup',
107			'$public',
108			SSViewer::DEFAULT_THEME,
109			],
110			'sea' => [
111			'mer',
112			'ocean',
113			SSViewer::DEFAULT_THEME,
114			],
115			],
116			'bee',
117			$expected
118			],
119			// Conflicting with root definitions
120			[
121			['main' => $expected = [
122			'subsite',
123			'backup',
124			'$public',
125			SSViewer::DEFAULT_THEME,
126			]],
127			'main',
128			$expected
129			],
130			// Declaring a theme specifically should still work
131			[
132			['test' => [
133			'subsite',
134			'backup',
135			'$public',
136			SSViewer::DEFAULT_THEME,
137			]],
138			'other',
139			array_merge(['other'], $this->themeList)
140			],
141			];
142			}
143			}
144

silverstripe / silverstripe-subsites

Push — master ( e73d62...b32499 )

customThemeDefinitionsAreRespectedProvider() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like