ImageRoute - Code Metrics - svycka/sv-images - Measure and Improve Code Quality continuously with Scrutinizer

ImageRoute A
last analyzed 2016-04-07 06:56 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	112
Duplicated Lines	5.36 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

53.49%

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
wmc	16
c	2
b	0
f	0
lcom	1
cbo	6
dl	6
loc	112
ccs	23
cts	43
cp	0.5349
rs	10

5 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	10	3
B	match()	0	27	5
B	assemble()	6	26	6
A	getAssembledParams()	0	5	1
A	factory()	0	4	1

How to fix Duplicated Code

<?php

namespace SvImages\Router;

use SvImages\Exception\RuntimeException;
use SvImages\Exception\TransformerNotFoundException;
use SvImages\Exception\UnexpectedValueException;
use SvImages\Parser\Result;
use SvImages\Parser\UriParser;
use Zend\Mvc\Router\Http\RouteInterface;
use Zend\Stdlib\RequestInterface as Request;
use Zend\Stdlib\ArrayUtils;
use Zend\Mvc\Router\Exception\InvalidArgumentException;

/**
 * @author Vytautas Stankus <[email protected]>
 * @license MIT
 */
class ImageRoute implements RouteInterface
{
    /**
     * Default route options
     *
     * @var array
     */
    protected $options = [
        'controller' => \SvImages\Controller\ImageController::class,
        'action' => 'image',
        'allow_options_override' => true,
    ];

    /**
     * Create a new page route.
     *
     * @param array $options
     */
    public function __construct(array $options = [])
    {
        if ($options instanceof \Traversable) {
            $options = ArrayUtils::iteratorToArray($options);
        } elseif (!is_array($options)) {
            throw new InvalidArgumentException(__METHOD__ . ' expects an array or Traversable set of options');
        }

        $this->options = array_merge($this->options, $options);
    }

    /**
     * Match a given request.
     *
     * @param  Request $request
     *
     * @return RouteMatch|null
     */
    public function match(Request $request)
    {
        if (!method_exists($request, 'getUri')) {
            return;
        }

        $uri  = $request->getUri();
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.
    }
}
        $path = $uri->getPath();

        try {
            $parser = new UriParser($this->options);
            $result = $parser->parseUri($path);

            if (!$result instanceof Result) {
                return;
            }
        } catch (UnexpectedValueException $exception) {
            return; // todo: think about this
        } catch (TransformerNotFoundException $exception) {
            return; // todo: think about this
        }

        $routeMatch = new RouteMatch($this->options, strlen($path));
        $routeMatch->setParserResult($result);

        return $routeMatch;
    }

    /**
     * {@inheritDoc}
     */
    public function assemble(array $params = [], array $options = [])
    {
        if (!array_key_exists('key', $params) || !is_string($params['key'])) {

            throw new UnexpectedValueException('Route params requires "key" parameter');
        }
        if (!array_key_exists('transformers', $params) || !is_string($params['transformers'])) {

            throw new UnexpectedValueException('Route params requires "transformers" parameter');
        }

        $path = sprintf(
            '/%s/%s/f_key/%s',
            $this->options['container'],
            trim($params['transformers'], '/'),
            ltrim($params['key'], '/')
        );
        $parser = new UriParser($this->options);
        $result = $parser->parseUri($path);

        if (!$result instanceof Result) {
            throw new RuntimeException(sprintf(
                'Generated URI "%s" is invalid. Please verify that all parameters are correct.',
                $path
            ));
        }
        return $path;
    }

    /**
     * {@inheritDoc}
     */
    public function getAssembledParams()
    {
        // TODO: Implement getAssembledParams() method.
        throw new \BadMethodCallException('Unsupported!');
    }

    /**
     * @private
     * @deprecated
     */
    public static function factory($options = [])
    {
        throw new \BadMethodCallException('Unsupported!');
    }
}


1			<?php
2
3			namespace SvImages\Router;
4
5			use SvImages\Exception\RuntimeException;
6			use SvImages\Exception\TransformerNotFoundException;
7			use SvImages\Exception\UnexpectedValueException;
8			use SvImages\Parser\Result;
9			use SvImages\Parser\UriParser;
10			use Zend\Mvc\Router\Http\RouteInterface;
11			use Zend\Stdlib\RequestInterface as Request;
12			use Zend\Stdlib\ArrayUtils;
13			use Zend\Mvc\Router\Exception\InvalidArgumentException;
14
15			/**
16			* @author Vytautas Stankus <[email protected]>
17			* @license MIT
18			*/
19			class ImageRoute implements RouteInterface
20			{
21			/**
22			* Default route options
23			*
24			* @var array
25			*/
26			protected $options = [
27			'controller' => \SvImages\Controller\ImageController::class,
28			'action' => 'image',
29			'allow_options_override' => true,
30			];
31
32			/**
33			* Create a new page route.
34			*
35			* @param array $options
36			*/
37	5		public function __construct(array $options = [])
38			{
39	5		if ($options instanceof \Traversable) {
40			$options = ArrayUtils::iteratorToArray($options);
41	5		} elseif (!is_array($options)) {
42			throw new InvalidArgumentException(__METHOD__ . ' expects an array or Traversable set of options');
43			}
44
45	5		$this->options = array_merge($this->options, $options);
46	5		}
47
48			/**
49			* Match a given request.
50			*
51			* @param Request $request
52			*
53			* @return RouteMatch\|null
54			*/
55			public function match(Request $request)
56			{
57			if (!method_exists($request, 'getUri')) {
58			return;
59			}
60
61			$uri = $request->getUri();
			0 ignored issues – show Bug introduced 2016-04-06 14:42 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Zend\Stdlib\RequestInterface` as the method `getUri()` does only exist in the following implementations of said interface: `Zend\Http\PhpEnvironment\Request`, `Zend\Http\Request`. 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...
62			$path = $uri->getPath();
63
64			try {
65			$parser = new UriParser($this->options);
66			$result = $parser->parseUri($path);
67
68			if (!$result instanceof Result) {
69			return;
70			}
71			} catch (UnexpectedValueException $exception) {
72			return; // todo: think about this
73			} catch (TransformerNotFoundException $exception) {
74			return; // todo: think about this
75			}
76
77			$routeMatch = new RouteMatch($this->options, strlen($path));
78			$routeMatch->setParserResult($result);
79
80			return $routeMatch;
81			}
82
83			/**
84			* {@inheritDoc}
85			*/
86	5		public function assemble(array $params = [], array $options = [])
87			{
88	5	View Code Duplication	if (!array_key_exists('key', $params) \|\| !is_string($params['key'])) {
			0 ignored issues – show Duplication introduced 2016-03-01 07:52 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
89	1		throw new UnexpectedValueException('Route params requires "key" parameter');
90			}
91	4	View Code Duplication	if (!array_key_exists('transformers', $params) \|\| !is_string($params['transformers'])) {
			0 ignored issues – show Duplication introduced 2016-03-01 07:52 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
92	1		throw new UnexpectedValueException('Route params requires "transformers" parameter');
93			}
94
95	3		$path = sprintf(
96	3		'/%s/%s/f_key/%s',
97	3		$this->options['container'],
98	3		trim($params['transformers'], '/'),
99	3		ltrim($params['key'], '/')
100	3		);
101	3		$parser = new UriParser($this->options);
102	3		$result = $parser->parseUri($path);
103
104	2		if (!$result instanceof Result) {
105	1		throw new RuntimeException(sprintf(
106	1		'Generated URI "%s" is invalid. Please verify that all parameters are correct.',
107			$path
108	1		));
109			}
110	1		return $path;
111			}
112
113			/**
114			* {@inheritDoc}
115			*/
116			public function getAssembledParams()
117			{
118			// TODO: Implement getAssembledParams() method.
119			throw new \BadMethodCallException('Unsupported!');
120			}
121
122			/**
123			* @private
124			* @deprecated
125			*/
126			public static function factory($options = [])
127			{
128			throw new \BadMethodCallException('Unsupported!');
129			}
130			}
131

svycka / sv-images

ImageRoute A last analyzed 2016-04-07 06:56 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

5 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Duplication Side-by-Side

Filter issues like

ImageRoute A
last analyzed 2016-04-07 06:56 UTC