SilverStripeCollectorTest::testGetWidgets() - Code Metrics - Inspection of "NEW TemplateCache tab (showing partial caching hit..." - lekoala/silverstripe-debugbar - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#78)

by Franco

created 2017-07-20 02:08 UTC

SilverStripeCollectorTest::testGetWidgets() B

↳ Parent: SilverStripeCollectorTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	79
Code Lines	61

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	79
rs	8.8701
c	0
b	0
f	0
cc	1
eloc	61
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\Control\Session;
use SilverStripe\Dev\SapphireTest;
use SilverStripe\Security\Member;
use SilverStripe\SiteConfig\SiteConfig;
use SilverStripe\View\Requirements;

class SilverStripeCollectorTest extends SapphireTest
{
    /**
     * @var DebugBarSilverStripeCollector
     */
    protected $collector;

    protected $usesDatabase = true;

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

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

    public function testCollect()
    {
        $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']);

        Member::currentUser()->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->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
            ),
            'partialCache' => array(
                'icon' => 'asterisk',
                'widget' => 'PhpDebugBar.Widgets.ConfigWidget',
                'map' => "silverstripe.partialCache.calls",
                'default' => '{}'
            ),
            'partialCache:badge' => array(
                'map' => 'silverstripe.partialCache.count',
                'default' => 0
            )
        );

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

    public function testGetAssets()

    {
        $expected = array(
            'base_path' => '/debugbar/javascript',
            'base_url' => 'debugbar/javascript',
            'css' => array(),
            'js' => 'widgets.js',
        );
        $this->assertSame($expected, $this->collector->getAssets());
    }
}


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\Control\Session;
10		use SilverStripe\Dev\SapphireTest;
11		use SilverStripe\Security\Member;
12		use SilverStripe\SiteConfig\SiteConfig;
13		use SilverStripe\View\Requirements;
14
15		class SilverStripeCollectorTest extends SapphireTest
16		{
17		/**
18		* @var DebugBarSilverStripeCollector
19		*/
20		protected $collector;
21
22		protected $usesDatabase = true;
23
24		public function setUp()
25		{
26		parent::setUp();
27		DebugBar::initDebugBar();
28		$this->collector = DebugBar::getDebugBar()->getCollector('silverstripe');
29		}
30
31		public function testCollectorExists()
32		{
33		$this->assertInstanceOf(SilverStripeCollector::class, $this->collector);
34		}
35
36		public function testCollect()
37		{
38		$data = $this->collector->collect();
39
40		$this->assertArrayHasKey('debug', $data);
41		$this->assertArrayHasKey('locale', $data);
42		$this->assertArrayHasKey('parameters', $data);
43		$this->assertArrayHasKey('templates', $data);
44		$this->assertContains('Framework', $data['version']);
45		$this->assertSame(SiteConfig::class, $data['config']['ClassName']);
46		$this->assertSame('User, ADMIN', $data['user']);
47		$this->assertCount(0, $data['requirements']);
48
49		Member::currentUser()->logOut();
		0 ignored issues – show Deprecated Code introduced 2017-07-10 04:48 UTC by Report Bug Copy Issue Report The method `SilverStripe\Security\Member::currentUser()` has been deprecated with message: 5.0.0 use Security::getCurrentUser() This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
50		$data = $this->collector->collect();
51		$this->assertSame('Not logged in', $data['user']);
52		}
53
54		public function testShowRequirements()
55		{
56		Requirements::css('debugbar/assets/debugbar.css');
57		$data = $this->collector->collect();
58		$this->assertArrayHasKey('requirements', $data);
59		$this->assertNotEmpty($data['requirements']);
60		$this->assertContains('assets/debugbar.css', $data['requirements'][0]);
61		}
62
63		public function testShowRequestParameters()
64		{
65		$controller = new Controller;
66		$controller->doInit();
67		$controller->setRequest(
68		new HTTPRequest(
69		'GET',
70		'/',
71		array('getvar' => 'value', 'foo' => 'bar'),
72		array('postvar' => 'value', 'bar' => 'baz')
73		)
74		);
75		$controller->getRequest()->setRouteParams(array('something' => 'here'));
76
77		$this->collector->setController($controller);
78		$this->assertSame($controller, $this->collector->getController());
79
80		$result = SilverStripeCollector::getRequestParameters();
81		$this->assertSame('value', $result['GET - getvar']);
82		$this->assertSame('baz', $result['POST - bar']);
83		$this->assertSame('here', $result['ROUTE - something']);
84		}
85
86		public function testGetSessionData()
87		{
88		Controller::curr()->getRequest()->getSession()->set('DebugBarTesting', 'test value');
89		$result = SilverStripeCollector::getSessionData();
90		$this->assertSame('test value', $result['DebugBarTesting']);
91		}
92
93		public function testGetConfigData()
94		{
95		$result = SilverStripeCollector::getConfigData();
96		$this->assertSame(SiteConfig::class, $result['ClassName']);
97		$this->assertArrayHasKey('Title', $result);
98		$this->assertArrayHasKey('ID', $result);
99		$this->assertArrayHasKey('Created', $result);
100		}
101
102		public function testGetWidgets()
103		{
104		$this->collector->collect();
105		$result = $this->collector->getWidgets();
106		// Stub out the dynamic data
107		$result['version']['tooltip'] = 'Stub';
108		$result['locale']['tooltip'] = 'Stub';
109		$result['user']['tooltip'] = 'Current member';
110
111		$expected = array(
112		'user' => array(
113		'icon' => 'user',
114		'tooltip' => 'Current member',
115		'default' => '',
116		),
117		'version' => array(
118		'icon' => 'desktop',
119		'tooltip' => 'Stub',
120		'default' => '',
121		),
122		'locale' => array(
123		'icon' => 'globe',
124		'tooltip' => 'Stub',
125		'default' => '',
126		),
127		'session' => array(
128		'icon' => 'archive',
129		'widget' => 'PhpDebugBar.Widgets.VariableListWidget',
130		'map' => 'silverstripe.session',
131		'default' => '{}',
132		),
133		'cookies' => array(
134		'icon' => 'asterisk',
135		'widget' => 'PhpDebugBar.Widgets.VariableListWidget',
136		'map' => 'silverstripe.cookies',
137		'default' => '{}',
138		),
139		'parameters' => array(
140		'icon' => 'arrow-right',
141		'widget' => 'PhpDebugBar.Widgets.VariableListWidget',
142		'map' => 'silverstripe.parameters',
143		'default' => '{}',
144		),
145		'SiteConfig' => array(
146		'icon' => 'gear',
147		'widget' => 'PhpDebugBar.Widgets.VariableListWidget',
148		'map' => 'silverstripe.config',
149		'default' => '{}',
150		),
151		'requirements' => array(
152		'icon' => 'file-o ',
153		'widget' => 'PhpDebugBar.Widgets.ListWidget',
154		'map' => 'silverstripe.requirements',
155		'default' => '{}',
156		),
157		'templates' => array(
158		'icon' => 'edit',
159		'widget' => 'PhpDebugBar.Widgets.ListWidget',
160		'map' => "silverstripe.templates.templates",
161		'default' => '{}'
162		),
163		'templates:badge' => array(
164		'map' => 'silverstripe.templates.count',
165		'default' => 0
166		),
167		'partialCache' => array(
168		'icon' => 'asterisk',
169		'widget' => 'PhpDebugBar.Widgets.ConfigWidget',
170		'map' => "silverstripe.partialCache.calls",
171		'default' => '{}'
172		),
173		'partialCache:badge' => array(
174		'map' => 'silverstripe.partialCache.count',
175		'default' => 0
176		)
177		);
178
179		$this->assertSame($expected, $result);
180		}
181
182	View Code Duplication	public function testGetAssets()
		0 ignored issues – show Duplication introduced 2017-07-04 12:14 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
183		{
184		$expected = array(
185		'base_path' => '/debugbar/javascript',
186		'base_url' => 'debugbar/javascript',
187		'css' => array(),
188		'js' => 'widgets.js',
189		);
190		$this->assertSame($expected, $this->collector->getAssets());
191		}
192		}
193

lekoala / silverstripe-debugbar

Pull Request — master (#78)

SilverStripeCollectorTest::testGetWidgets() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like