Route::rewrite() - Code Metrics - Inspection of "rename project to Obsidian" - htmlburger/wpemerge - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b7467b...db04eb )

by Atanas

created 2017-11-23 15:07 UTC

Route::rewrite() A

↳ Parent: Route

Complexity

Conditions	2
Paths	2

Size

Total Lines	15
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
cc	2
eloc	9
nc	2
nop	1
dl	0
loc	15
rs	9.4285
c	0
b	0
f	0
ccs	0
cts	10
cp	0
crap	6

<?php

namespace Obsidian\Routing;

use Obsidian\Middleware\HasMiddlewareTrait;
use Obsidian\Request;
use Obsidian\Routing\Conditions\ConditionInterface;
use Obsidian\Routing\Conditions\Factory;
use Obsidian\Routing\Conditions\InvalidRouteConditionException;
use Obsidian\Routing\Conditions\Url as UrlCondition;
use Exception;

/**
 * Represent a route
 */
class Route implements RouteInterface {
	use HasMiddlewareTrait;

	/**
	 * Allowed methods
	 *
	 * @var string[]
	 */
	protected $methods = [];

	/**
	 * Route target
	 *
	 * @var ConditionInterface
	 */
	protected $target = null;

	/**
	 * Route handler
	 *
	 * @var Handler|null
	 */
	protected $handler = null;

	/**
	 * Constructor
	 *
	 * @param string[]        $methods
	 * @param mixed           $target
	 * @param string|\Closure $handler
	 */
	public function __construct( $methods, $target, $handler ) {
		if ( ! is_a( $target, ConditionInterface::class ) ) {
			try {
				$target = Factory::make( $target );
			} catch ( InvalidRouteConditionException $e ) {
				throw new Exception( 'Route target is not a valid route string or condition.' );
			}
		}

		$this->methods = $methods;
		$this->target = $target;
		$this->handler = new Handler( $handler );
	}

	/**
	 * {@inheritDoc}
	 */
	public function satisfied( Request $request ) {
		if ( ! in_array( $request->getMethod(), $this->methods) ) {
			return false;
		}
		return $this->target->satisfied( $request );
	}

	/**
	 * {@inheritDoc}
	 */
	public function handle( Request $request, $template ) {
		$arguments = array_merge( [$request, $template], $this->target->getArguments( $request ) );
		return $this->executeMiddleware( $this->getMiddleware(), $request, function() use ( $arguments ) {
			return call_user_func_array( [$this->handler, 'execute'], $arguments );
		} );
	}

	/**
	 * Add a rewrite rule to WordPress for url-based routes
	 *
	 * @param  string $rewrite_to
	 * @return RouteInterface
	 */
	public function rewrite( $rewrite_to ) {
		if ( ! is_a( $this->target, UrlCondition::class ) ) {
			throw new Exception( 'Only routes with url targets can add rewrite rules.' );
		}

		$regex = $this->target->getValidationRegex( $this->target->getUrl(), false );
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
		$regex = preg_replace( '~^\^/~', '^', $regex ); // rewrite rules require NO leading slash

		add_filter( 'obsidian_routing_rewrite_rules', function( $rules ) use ( $regex, $rewrite_to ) {
			$rules[ $regex ] = $rewrite_to;
			return $rules;
		} );

		return $this;
	}
}


Push — master ( b7467b...db04eb )

Route::rewrite() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

1			<?php
2
3			namespace Obsidian\Routing;
4
5			use Obsidian\Middleware\HasMiddlewareTrait;
6			use Obsidian\Request;
7			use Obsidian\Routing\Conditions\ConditionInterface;
8			use Obsidian\Routing\Conditions\Factory;
9			use Obsidian\Routing\Conditions\InvalidRouteConditionException;
10			use Obsidian\Routing\Conditions\Url as UrlCondition;
11			use Exception;
12
13			/**
14			* Represent a route
15			*/
16			class Route implements RouteInterface {
17			use HasMiddlewareTrait;
18
19			/**
20			* Allowed methods
21			*
22			* @var string[]
23			*/
24			protected $methods = [];
25
26			/**
27			* Route target
28			*
29			* @var ConditionInterface
30			*/
31			protected $target = null;
32
33			/**
34			* Route handler
35			*
36			* @var Handler\|null
37			*/
38			protected $handler = null;
39
40			/**
41			* Constructor
42			*
43			* @param string[] $methods
44			* @param mixed $target
45			* @param string\|\Closure $handler
46			*/
47			public function __construct( $methods, $target, $handler ) {
48			if ( ! is_a( $target, ConditionInterface::class ) ) {
49			try {
50			$target = Factory::make( $target );
51			} catch ( InvalidRouteConditionException $e ) {
52			throw new Exception( 'Route target is not a valid route string or condition.' );
53			}
54			}
55
56			$this->methods = $methods;
57			$this->target = $target;
58			$this->handler = new Handler( $handler );
59			}
60
61			/**
62			* {@inheritDoc}
63			*/
64			public function satisfied( Request $request ) {
65			if ( ! in_array( $request->getMethod(), $this->methods) ) {
66			return false;
67			}
68			return $this->target->satisfied( $request );
69			}
70
71			/**
72			* {@inheritDoc}
73			*/
74			public function handle( Request $request, $template ) {
75			$arguments = array_merge( [$request, $template], $this->target->getArguments( $request ) );
76			return $this->executeMiddleware( $this->getMiddleware(), $request, function() use ( $arguments ) {
77			return call_user_func_array( [$this->handler, 'execute'], $arguments );
78			} );
79			}
80
81			/**
82			* Add a rewrite rule to WordPress for url-based routes
83			*
84			* @param string $rewrite_to
85			* @return RouteInterface
86			*/
87			public function rewrite( $rewrite_to ) {
88			if ( ! is_a( $this->target, UrlCondition::class ) ) {
89			throw new Exception( 'Only routes with url targets can add rewrite rules.' );
90			}
91
92			$regex = $this->target->getValidationRegex( $this->target->getUrl(), false );
			0 ignored issues – show Bug introduced 2017-11-23 15:09 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Obsidian\Routing\Conditions\ConditionInterface` as the method `getUrl()` does only exist in the following implementations of said interface: `Obsidian\Routing\Conditions\Url`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string / public function getDisplayName(); } Loading history... Bug introduced 2017-11-23 15:09 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Obsidian\Routing\Conditions\ConditionInterface` as the method `getValidationRegex()` does only exist in the following implementations of said interface: `Obsidian\Routing\Conditions\Url`. Let’s take a look at an example: interface User { /* @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
93			$regex = preg_replace( '~^\^/~', '^', $regex ); // rewrite rules require NO leading slash
94
95			add_filter( 'obsidian_routing_rewrite_rules', function( $rules ) use ( $regex, $rewrite_to ) {
96			$rules[ $regex ] = $rewrite_to;
97			return $rules;
98			} );
99
100			return $this;
101			}
102			}
103

htmlburger / wpemerge

Push — master ( b7467b...db04eb )

Route::rewrite() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like