SilverStripeCollectorTest::testGetWidgets() - Code Metrics - Inspection of "Make into vendormodule" - lekoala/silverstripe-debugbar - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#91)

by Andrew

created 2017-11-21 15:46 UTC

SilverStripeCollectorTest::testGetWidgets() A

↳ Parent: SilverStripeCollectorTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	71
Code Lines	55

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	71
rs	9.1369
cc	1
eloc	55
nc	1
nop	0

How to fix Long Method

<?php

namespace LeKoala\DebugBar\Test\Collector;

use LeKoala\DebugBar\DebugBar;
use LeKoala\DebugBar\Collector\SilverStripeCollector;
use SilverStripe\Control\Controller;
use SilverStripe\Control\HTTPRequest;
use SilverStripe\Core\Config\Config;
use SilverStripe\Core\Manifest\VersionProvider;
use SilverStripe\Dev\FunctionalTest;
use SilverStripe\SiteConfig\SiteConfig;
use SilverStripe\View\Requirements;
use SilverStripe\View\Requirements_Backend;

class SilverStripeCollectorTest extends FunctionalTest
{
    /**
     * @var SilverStripeCollector
     */
    protected $collector;

    protected $usesDatabase = true;

    public function setUp()
    {
        parent::setUp();
        DebugBar::initDebugBar();
        $this->collector = DebugBar::getDebugBar()->getCollector('silverstripe');
        Requirements::set_backend(Requirements_Backend::create());
    }

    public function tearDown()
    {
        parent::tearDown();
    }

    public function testCollectorExists()
    {
        $this->assertInstanceOf(SilverStripeCollector::class, $this->collector);
    }

    public function testCollect()
    {
        $this->logInWithPermission('ADMIN');
        Config::modify()->set(VersionProvider::class, 'modules', [
            'silverstripe/framework' => 'Framework',
            'silverstripe/cms' => 'CMS',
        ]);
        $data = $this->collector->collect();
        $this->assertArrayHasKey('debug', $data);
        $this->assertArrayHasKey('locale', $data);
        $this->assertArrayHasKey('parameters', $data);
        $this->assertArrayHasKey('templates', $data);
        $this->assertContains('Framework', $data['version']);
        $this->assertSame(SiteConfig::class, $data['config']['ClassName']);
        $this->assertSame('User, ADMIN', $data['user']);
        $this->assertCount(0, $data['requirements']);

        $this->logOut();

        $data = $this->collector->collect();
        $this->assertSame('Not logged in', $data['user']);
    }

    public function testShowRequirements()
    {
        Requirements::css('debugbar/assets/debugbar.css');
        $data = $this->collector->collect();
        $this->assertArrayHasKey('requirements', $data);
        $this->assertNotEmpty($data['requirements']);
        $this->assertContains('assets/debugbar.css', $data['requirements'][0]);
    }

    public function testShowRequestParameters()
    {
        $controller = new Controller;
        $controller->doInit();
        $controller->setRequest(
            new HTTPRequest(
                'GET',
                '/',
                array('getvar' => 'value', 'foo' => 'bar'),
                array('postvar' => 'value', 'bar' => 'baz')
            )
        );
        $controller->getRequest()->setRouteParams(array('something' => 'here'));

        $this->collector->setController($controller);
        $this->assertSame($controller, $this->collector->getController());

        $result = SilverStripeCollector::getRequestParameters();
        $this->assertSame('value', $result['GET - getvar']);
        $this->assertSame('baz', $result['POST - bar']);
        $this->assertSame('here', $result['ROUTE - something']);
    }

    public function testGetSessionData()
    {
        Controller::curr()->getRequest()->getSession()->set('DebugBarTesting', 'test value');
        $result = SilverStripeCollector::getSessionData();
        $this->assertSame('test value', $result['DebugBarTesting']);
    }

    public function testGetConfigData()
    {
        $result = SilverStripeCollector::getConfigData();
        $this->assertSame(SiteConfig::class, $result['ClassName']);
        $this->assertArrayHasKey('Title', $result);
        $this->assertArrayHasKey('ID', $result);
        $this->assertArrayHasKey('Created', $result);
    }

    public function testGetWidgets()
    {
        $this->logInWithPermission('ADMIN');
        $this->collector->collect();
        $result = $this->collector->getWidgets();
        // Stub out the dynamic data
        $result['version']['tooltip'] = 'Stub';
        $result['locale']['tooltip'] = 'Stub';
        $result['user']['tooltip'] = 'Current member';

        $expected = array(
            'user' => array(
                'icon' => 'user',
                'tooltip' => 'Current member',
                'default' => '',
            ),
            'version' => array(
                'icon' => 'desktop',
                'tooltip' => 'Stub',
                'default' => '',
            ),
            'locale' => array(
                'icon' => 'globe',
                'tooltip' => 'Stub',
                'default' => '',
            ),
            'session' => array(
                'icon' => 'archive',
                'widget' => 'PhpDebugBar.Widgets.VariableListWidget',
                'map' => 'silverstripe.session',
                'default' => '{}',
            ),
            'cookies' => array(
                'icon' => 'asterisk',
                'widget' => 'PhpDebugBar.Widgets.VariableListWidget',
                'map' => 'silverstripe.cookies',
                'default' => '{}',
            ),
            'parameters' => array(
                'icon' => 'arrow-right',
                'widget' => 'PhpDebugBar.Widgets.VariableListWidget',
                'map' => 'silverstripe.parameters',
                'default' => '{}',
            ),
            'SiteConfig' => array(
                'icon' => 'gear',
                'widget' => 'PhpDebugBar.Widgets.VariableListWidget',
                'map' => 'silverstripe.config',
                'default' => '{}',
            ),
            'requirements' => array(
                'icon' => 'file-o ',
                'widget' => 'PhpDebugBar.Widgets.ListWidget',
                'map' => 'silverstripe.requirements',
                'default' => '{}',
            ),
            'templates' => array(
                'icon' => 'edit',
                'widget' => 'PhpDebugBar.Widgets.ListWidget',
                'map' => "silverstripe.templates.templates",
                'default' => '{}'
            ),
            'templates:badge' => array(
                'map' => 'silverstripe.templates.count',
                'default' => 0
            )
        );

        $this->assertSame($expected, $result);
        $this->logOut();
    }

    public function testGetAssets()
    {
        $config = $this->collector->getAssets();

        $this->assertArrayHasKey('base_path', $config);
        $this->assertArrayHasKey('base_url', $config);
        $this->assertArrayHasKey('css', $config);
        $this->assertArrayHasKey('js', $config);
        // No CSS for this one
        $this->assertFileExists(implode(DIRECTORY_SEPARATOR, [BASE_PATH, $config['base_path'], $config['js']]));
    }
}


1			<?php
2
3			namespace LeKoala\DebugBar\Test\Collector;
4
5			use LeKoala\DebugBar\DebugBar;
6			use LeKoala\DebugBar\Collector\SilverStripeCollector;
7			use SilverStripe\Control\Controller;
8			use SilverStripe\Control\HTTPRequest;
9			use SilverStripe\Core\Config\Config;
10			use SilverStripe\Core\Manifest\VersionProvider;
11			use SilverStripe\Dev\FunctionalTest;
12			use SilverStripe\SiteConfig\SiteConfig;
13			use SilverStripe\View\Requirements;
14			use SilverStripe\View\Requirements_Backend;
15
16			class SilverStripeCollectorTest extends FunctionalTest
17			{
18			/**
19			* @var SilverStripeCollector
20			*/
21			protected $collector;
22
23			protected $usesDatabase = true;
24
25			public function setUp()
26			{
27			parent::setUp();
28			DebugBar::initDebugBar();
29			$this->collector = DebugBar::getDebugBar()->getCollector('silverstripe');
30			Requirements::set_backend(Requirements_Backend::create());
31			}
32
33			public function tearDown()
34			{
35			parent::tearDown();
36			}
37
38			public function testCollectorExists()
39			{
40			$this->assertInstanceOf(SilverStripeCollector::class, $this->collector);
41			}
42
43			public function testCollect()
44			{
45			$this->logInWithPermission('ADMIN');
46			Config::modify()->set(VersionProvider::class, 'modules', [
47			'silverstripe/framework' => 'Framework',
48			'silverstripe/cms' => 'CMS',
49			]);
50			$data = $this->collector->collect();
51			$this->assertArrayHasKey('debug', $data);
52			$this->assertArrayHasKey('locale', $data);
53			$this->assertArrayHasKey('parameters', $data);
54			$this->assertArrayHasKey('templates', $data);
55			$this->assertContains('Framework', $data['version']);
56			$this->assertSame(SiteConfig::class, $data['config']['ClassName']);
57			$this->assertSame('User, ADMIN', $data['user']);
58			$this->assertCount(0, $data['requirements']);
59
60			$this->logOut();
61
62			$data = $this->collector->collect();
63			$this->assertSame('Not logged in', $data['user']);
64			}
65
66			public function testShowRequirements()
67			{
68			Requirements::css('debugbar/assets/debugbar.css');
69			$data = $this->collector->collect();
70			$this->assertArrayHasKey('requirements', $data);
71			$this->assertNotEmpty($data['requirements']);
72			$this->assertContains('assets/debugbar.css', $data['requirements'][0]);
73			}
74
75			public function testShowRequestParameters()
76			{
77			$controller = new Controller;
78			$controller->doInit();
79			$controller->setRequest(
80			new HTTPRequest(
81			'GET',
82			'/',
83			array('getvar' => 'value', 'foo' => 'bar'),
84			array('postvar' => 'value', 'bar' => 'baz')
85			)
86			);
87			$controller->getRequest()->setRouteParams(array('something' => 'here'));
88
89			$this->collector->setController($controller);
90			$this->assertSame($controller, $this->collector->getController());
91
92			$result = SilverStripeCollector::getRequestParameters();
93			$this->assertSame('value', $result['GET - getvar']);
94			$this->assertSame('baz', $result['POST - bar']);
95			$this->assertSame('here', $result['ROUTE - something']);
96			}
97
98			public function testGetSessionData()
99			{
100			Controller::curr()->getRequest()->getSession()->set('DebugBarTesting', 'test value');
101			$result = SilverStripeCollector::getSessionData();
102			$this->assertSame('test value', $result['DebugBarTesting']);
103			}
104
105			public function testGetConfigData()
106			{
107			$result = SilverStripeCollector::getConfigData();
108			$this->assertSame(SiteConfig::class, $result['ClassName']);
109			$this->assertArrayHasKey('Title', $result);
110			$this->assertArrayHasKey('ID', $result);
111			$this->assertArrayHasKey('Created', $result);
112			}
113
114			public function testGetWidgets()
115			{
116			$this->logInWithPermission('ADMIN');
117			$this->collector->collect();
118			$result = $this->collector->getWidgets();
119			// Stub out the dynamic data
120			$result['version']['tooltip'] = 'Stub';
121			$result['locale']['tooltip'] = 'Stub';
122			$result['user']['tooltip'] = 'Current member';
123
124			$expected = array(
125			'user' => array(
126			'icon' => 'user',
127			'tooltip' => 'Current member',
128			'default' => '',
129			),
130			'version' => array(
131			'icon' => 'desktop',
132			'tooltip' => 'Stub',
133			'default' => '',
134			),
135			'locale' => array(
136			'icon' => 'globe',
137			'tooltip' => 'Stub',
138			'default' => '',
139			),
140			'session' => array(
141			'icon' => 'archive',
142			'widget' => 'PhpDebugBar.Widgets.VariableListWidget',
143			'map' => 'silverstripe.session',
144			'default' => '{}',
145			),
146			'cookies' => array(
147			'icon' => 'asterisk',
148			'widget' => 'PhpDebugBar.Widgets.VariableListWidget',
149			'map' => 'silverstripe.cookies',
150			'default' => '{}',
151			),
152			'parameters' => array(
153			'icon' => 'arrow-right',
154			'widget' => 'PhpDebugBar.Widgets.VariableListWidget',
155			'map' => 'silverstripe.parameters',
156			'default' => '{}',
157			),
158			'SiteConfig' => array(
159			'icon' => 'gear',
160			'widget' => 'PhpDebugBar.Widgets.VariableListWidget',
161			'map' => 'silverstripe.config',
162			'default' => '{}',
163			),
164			'requirements' => array(
165			'icon' => 'file-o ',
166			'widget' => 'PhpDebugBar.Widgets.ListWidget',
167			'map' => 'silverstripe.requirements',
168			'default' => '{}',
169			),
170			'templates' => array(
171			'icon' => 'edit',
172			'widget' => 'PhpDebugBar.Widgets.ListWidget',
173			'map' => "silverstripe.templates.templates",
174			'default' => '{}'
175			),
176			'templates:badge' => array(
177			'map' => 'silverstripe.templates.count',
178			'default' => 0
179			)
180			);
181
182			$this->assertSame($expected, $result);
183			$this->logOut();
184			}
185
186			public function testGetAssets()
187			{
188			$config = $this->collector->getAssets();
189
190			$this->assertArrayHasKey('base_path', $config);
191			$this->assertArrayHasKey('base_url', $config);
192			$this->assertArrayHasKey('css', $config);
193			$this->assertArrayHasKey('js', $config);
194			// No CSS for this one
195			$this->assertFileExists(implode(DIRECTORY_SEPARATOR, [BASE_PATH, $config['base_path'], $config['js']]));
196			}
197			}
198

lekoala / silverstripe-debugbar

Pull Request — master (#91)

SilverStripeCollectorTest::testGetWidgets() A

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like