URLConfirmationTokenTest::testValidToken() - Code Metrics - Inspection of "Merge branch '3.6' into 3.7" - silverstripe/silverstripe-framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 3.7 ( 8061e7...a7d511 )

unknown

created 2018-11-06 22:36 UTC

URLConfirmationTokenTest::testValidToken() A

↳ Parent: URLConfirmationTokenTest

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	11
rs	9.9
c	0
b	0
f	0

<?php

class URLConfirmationTokenTest_StubToken extends URLConfirmationToken implements TestOnly {
	public function urlMatches() {
		return parent::urlMatches();
	}

	public function currentURL() {
		return parent::currentURL();
	}

	public function redirectURL() {
		return parent::redirectURL();
	}
}

class URLConfirmationTokenTest_StubValidToken extends URLConfirmationTokenTest_StubToken {
	protected function checkToken($token) {
		return true;
	}
}

class URLConfirmationTokenTest extends SapphireTest {

	protected $originalURL;

	protected $originalGetVars;

	public function setUp() {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
		parent::setUp();
		global $url;
function myFunction($a, $b) {
    // Do something
}
		$this->originalURL = $url;
		$this->originalGetVars = $_GET;
	}

	public function tearDown() {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
		parent::tearDown();
		global $url;
function myFunction($a, $b) {
    // Do something
}
		$url = $this->originalURL;
		$_GET = $this->originalGetVars;
	}

	public function testValidToken() {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
		global $url;
function myFunction($a, $b) {
    // Do something
}
		$url = Controller::join_links(BASE_URL, '/', 'token/test/url');
		$_GET = array('tokentesturltoken' => 'value', 'url' => $url);

		$validToken = new URLConfirmationTokenTest_StubValidToken('token/test/url');
		$this->assertTrue($validToken->urlMatches());
		$this->assertTrue($validToken->tokenProvided()); // Actually forced to true for this test
		$this->assertFalse($validToken->reloadRequired());
		$this->assertStringStartsWith(Controller::join_links(BASE_URL, '/', 'token/test/url'), $validToken->redirectURL());
	}

	public function testTokenWithTrailingSlashInUrl() {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
		global $url;
function myFunction($a, $b) {
    // Do something
}
		$url = Controller::join_links(BASE_URL, '/', 'trailing/slash/url/');
		$_GET = array('url' => $url);

		$trailingSlash = new URLConfirmationTokenTest_StubToken('trailing/slash/url');
		$this->assertTrue($trailingSlash->urlMatches());
		$this->assertFalse($trailingSlash->tokenProvided());
		$this->assertTrue($trailingSlash->reloadRequired());
		$this->assertContains('trailing/slash/url', $trailingSlash->redirectURL());
		$this->assertContains('trailingslashurltoken', $trailingSlash->redirectURL());
	}

	public function testUrlSuppressionWhenTokenMissing()
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
	{
		global $url;
function myFunction($a, $b) {
    // Do something
}
		$url = Controller::join_links(BASE_URL, '/', 'test/url/');
		$_GET = array('url' => $url);

		$token = new URLConfirmationTokenTest_StubToken('test/url');
		$token->suppress();
		$this->assertEquals('/', $_GET['url']);
	}
}


1			<?php
2
3			class URLConfirmationTokenTest_StubToken extends URLConfirmationToken implements TestOnly {
4			public function urlMatches() {
5			return parent::urlMatches();
6			}
7
8			public function currentURL() {
9			return parent::currentURL();
10			}
11
12			public function redirectURL() {
13			return parent::redirectURL();
14			}
15			}
16
17			class URLConfirmationTokenTest_StubValidToken extends URLConfirmationTokenTest_StubToken {
18			protected function checkToken($token) {
19			return true;
20			}
21			}
22
23			class URLConfirmationTokenTest extends SapphireTest {
24
25			protected $originalURL;
26
27			protected $originalGetVars;
28
29			public function setUp() {
			0 ignored issues – show Coding Style introduced 2018-11-06 23:28 UTC by Report Bug Copy Issue Report `setUp` uses the super-global variable `$_GET` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
30			parent::setUp();
31			global $url;
			0 ignored issues – show Compatibility Best Practice introduced 2018-11-06 23:28 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
32			$this->originalURL = $url;
33			$this->originalGetVars = $_GET;
34			}
35
36			public function tearDown() {
			0 ignored issues – show Coding Style introduced 2018-11-06 23:28 UTC by Report Bug Copy Issue Report `tearDown` uses the super-global variable `$_GET` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
37			parent::tearDown();
38			global $url;
			0 ignored issues – show Compatibility Best Practice introduced 2018-11-06 23:28 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
39			$url = $this->originalURL;
40			$_GET = $this->originalGetVars;
41			}
42
43			public function testValidToken() {
			0 ignored issues – show Coding Style introduced 2018-11-06 23:28 UTC by Report Bug Copy Issue Report `testValidToken` uses the super-global variable `$_GET` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
44			global $url;
			0 ignored issues – show Compatibility Best Practice introduced 2018-11-06 23:28 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
45			$url = Controller::join_links(BASE_URL, '/', 'token/test/url');
46			$_GET = array('tokentesturltoken' => 'value', 'url' => $url);
47
48			$validToken = new URLConfirmationTokenTest_StubValidToken('token/test/url');
49			$this->assertTrue($validToken->urlMatches());
50			$this->assertTrue($validToken->tokenProvided()); // Actually forced to true for this test
51			$this->assertFalse($validToken->reloadRequired());
52			$this->assertStringStartsWith(Controller::join_links(BASE_URL, '/', 'token/test/url'), $validToken->redirectURL());
53			}
54
55			public function testTokenWithTrailingSlashInUrl() {
			0 ignored issues – show Coding Style introduced 2018-11-06 23:28 UTC by Report Bug Copy Issue Report `testTokenWithTrailingSlashInUrl` uses the super-global variable `$_GET` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
56			global $url;
			0 ignored issues – show Compatibility Best Practice introduced 2018-11-06 23:28 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
57			$url = Controller::join_links(BASE_URL, '/', 'trailing/slash/url/');
58			$_GET = array('url' => $url);
59
60			$trailingSlash = new URLConfirmationTokenTest_StubToken('trailing/slash/url');
61			$this->assertTrue($trailingSlash->urlMatches());
62			$this->assertFalse($trailingSlash->tokenProvided());
63			$this->assertTrue($trailingSlash->reloadRequired());
64			$this->assertContains('trailing/slash/url', $trailingSlash->redirectURL());
65			$this->assertContains('trailingslashurltoken', $trailingSlash->redirectURL());
66			}
67
68			public function testUrlSuppressionWhenTokenMissing()
			0 ignored issues – show Coding Style introduced 2018-11-06 23:28 UTC by Report Bug Copy Issue Report `testUrlSuppressionWhenTokenMissing` uses the super-global variable `$_GET` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
69			{
70			global $url;
			0 ignored issues – show Compatibility Best Practice introduced 2018-11-06 23:28 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
71			$url = Controller::join_links(BASE_URL, '/', 'test/url/');
72			$_GET = array('url' => $url);
73
74			$token = new URLConfirmationTokenTest_StubToken('test/url');
75			$token->suppress();
76			$this->assertEquals('/', $_GET['url']);
77			}
78			}
79

silverstripe / silverstripe-framework

Push — 3.7 ( 8061e7...a7d511 )

URLConfirmationTokenTest::testValidToken() A

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like