JsonSchemaInterceptor::invoke() - Code Metrics - Inspection of "Merge pull request #127 from koriym/refactor" - bearsunday/BEAR.Resource - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — 1.x (2c7718)

by Akihito

created 2018-03-02 17:25 UTC

JsonSchemaInterceptor::invoke() B

↳ Parent: JsonSchemaInterceptor

Complexity

Conditions	6
Paths	7

Size

Total Lines	20
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	6.1308

Importance

Changes	8
Bugs	0	Features	2

Metric	Value
dl	0
loc	20
ccs	11
cts	13
cp	0.8462
rs	8.8571
c	8
b	0
f	2
cc	6
eloc	13
nc	7
nop	1
crap	6.1308

<?php
/**
 * This file is part of the BEAR.Resource package.
 *
 * @license http://opensource.org/licenses/MIT MIT
 */
namespace BEAR\Resource\Interceptor;

use BEAR\Resource\Annotation\JsonSchema;
use BEAR\Resource\Code;
use BEAR\Resource\Exception\JsonSchemaErrorException;
use BEAR\Resource\Exception\JsonSchemaException;
use BEAR\Resource\Exception\JsonSchemaNotFoundException;
use BEAR\Resource\ResourceObject;
use JsonSchema\Constraints\Constraint;
use JsonSchema\Validator;
use Ray\Aop\MethodInterceptor;
use Ray\Aop\MethodInvocation;
use Ray\Aop\WeavedInterface;
use Ray\Di\Di\Named;

final class JsonSchemaInterceptor implements MethodInterceptor
{
    /**
     * @var string
     */
    private $schemaDir;

    /**
     * @var string
     */
    private $validateDir;

    /**
     * @param string $schemaDir
     * @param string $validateDir
     *
     * @Named("schemaDir=json_schema_dir,validateDir=json_validate_dir")
     */
    public function __construct($schemaDir, $validateDir)
    {
        $this->schemaDir = $schemaDir;
        $this->validateDir = $validateDir;
    }

    /**
     * {@inheritdoc}
     */
    public function invoke(MethodInvocation $invocation)
    {
        $jsonSchema = $invocation->getMethod()->getAnnotation(JsonSchema::class);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}
        if (! $jsonSchema instanceof JsonSchema) {
            throw new JsonSchemaException($invocation->getMethod()->name);
        }
        if ($jsonSchema->params) {
            $arguments = $this->getNamedArguments($invocation);
            $this->validateRequest($jsonSchema, $arguments);
        }
        $ro = $invocation->proceed();
        if (! $ro instanceof ResourceObject) {
            throw new JsonSchemaException($invocation->getMethod()->name);
        }
        if ($ro->code === 200 || $ro->code == 201) {
            $this->validateResponse($jsonSchema, $ro);
        }

        return $ro;
    }

    private function validateRequest(JsonSchema $jsonSchema, array $arguments)
    {
        $schemaFile = $this->validateDir . '/' . $jsonSchema->params;
        $this->validateFileExists($schemaFile);
        $this->validate($arguments, $schemaFile);
    }

    private function validateResponse(JsonSchema $jsonSchema, ResourceObject $ro)
    {
        $schemeFile = $this->getSchemaFile($jsonSchema, $ro);
        $body = isset($ro->body[$jsonSchema->key]) ? $ro->body[$jsonSchema->key] : $ro->body;
        $this->validate($body, $schemeFile);
    }

    private function validate($scanObject, $schemaFile)
    {
        $validator = new Validator;
        $schema = (object) ['$ref' => 'file://' . $schemaFile];
        $validator->validate($scanObject, $schema, Constraint::CHECK_MODE_TYPE_CAST);
        $isValid = $validator->isValid();
        if ($isValid) {
            return;
        }
        $e = null;
        foreach ($validator->getErrors() as $error) {
            $msg = sprintf('[%s] %s', $error['property'], $error['message']);
            $e = $e ? new JsonSchemaErrorException($msg, 0, $e) : new JsonSchemaErrorException($msg);
        }
        throw new JsonSchemaException($schemaFile, Code::ERROR, $e);
    }

    private function getSchemaFile(JsonSchema $jsonSchema, ResourceObject $ro) : string
    {
        if (! $jsonSchema->schema) {
            // for BC only
            $ref = new \ReflectionClass($ro);
            $roFileName = $ro instanceof WeavedInterface ? $roFileName = $ref->getParentClass()->getFileName() : $ref->getFileName();
            $bcFile = str_replace('.php', '.json', $roFileName);
            if (file_exists($bcFile)) {
                return $bcFile;
            }
        }
        $schemaFile = $this->schemaDir . '/' . $jsonSchema->schema;
        $this->validateFileExists($schemaFile);

        return $schemaFile;
    }

    private function validateFileExists(string $schemaFile)
    {
        if (! file_exists($schemaFile) || is_dir($schemaFile)) {
            throw new JsonSchemaNotFoundException($schemaFile);
        }
    }

    private function getNamedArguments(MethodInvocation $invocation)
    {
        $parameters = $invocation->getMethod()->getParameters();
        $values = $invocation->getArguments();
        $arguments = [];
        foreach ($parameters as $index => $parameter) {
            $arguments[$parameter->name] = $values[$index] ?? $parameter->getDefaultValue();
        }

        return $arguments;
    }
}


1		<?php
2		/**
3		* This file is part of the BEAR.Resource package.
4		*
5		* @license http://opensource.org/licenses/MIT MIT
6		*/
7		namespace BEAR\Resource\Interceptor;
8
9		use BEAR\Resource\Annotation\JsonSchema;
10		use BEAR\Resource\Code;
11		use BEAR\Resource\Exception\JsonSchemaErrorException;
12		use BEAR\Resource\Exception\JsonSchemaException;
13		use BEAR\Resource\Exception\JsonSchemaNotFoundException;
14		use BEAR\Resource\ResourceObject;
15		use JsonSchema\Constraints\Constraint;
16		use JsonSchema\Validator;
17		use Ray\Aop\MethodInterceptor;
18		use Ray\Aop\MethodInvocation;
19		use Ray\Aop\WeavedInterface;
20		use Ray\Di\Di\Named;
21
22		final class JsonSchemaInterceptor implements MethodInterceptor
23		{
24		/**
25		* @var string
26		*/
27		private $schemaDir;
28
29		/**
30		* @var string
31		*/
32		private $validateDir;
33
34		/**
35		* @param string $schemaDir
36		* @param string $validateDir
37		*
38		* @Named("schemaDir=json_schema_dir,validateDir=json_validate_dir")
39		*/
40	7	public function __construct($schemaDir, $validateDir)
41		{
42	7	$this->schemaDir = $schemaDir;
43	7	$this->validateDir = $validateDir;
44	7	}
45
46		/**
47		* {@inheritdoc}
48		*/
49	7	public function invoke(MethodInvocation $invocation)
50		{
51	7	$jsonSchema = $invocation->getMethod()->getAnnotation(JsonSchema::class);
		0 ignored issues – show Bug introduced 2018-03-02 14:38 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `ReflectionMethod` as the method `getAnnotation()` does only exist in the following sub-classes of `ReflectionMethod`: `Ray\Aop\ReflectionMethod`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
52	7	if (! $jsonSchema instanceof JsonSchema) {
53		throw new JsonSchemaException($invocation->getMethod()->name);
54		}
55	7	if ($jsonSchema->params) {
56	3	$arguments = $this->getNamedArguments($invocation);
57	3	$this->validateRequest($jsonSchema, $arguments);
58		}
59	6	$ro = $invocation->proceed();
60	6	if (! $ro instanceof ResourceObject) {
61		throw new JsonSchemaException($invocation->getMethod()->name);
62		}
63	6	if ($ro->code === 200 \|\| $ro->code == 201) {
64	5	$this->validateResponse($jsonSchema, $ro);
65		}
66
67	3	return $ro;
68		}
69
70	3	private function validateRequest(JsonSchema $jsonSchema, array $arguments)
71		{
72	3	$schemaFile = $this->validateDir . '/' . $jsonSchema->params;
73	3	$this->validateFileExists($schemaFile);
74	3	$this->validate($arguments, $schemaFile);
75	2	}
76
77	5	private function validateResponse(JsonSchema $jsonSchema, ResourceObject $ro)
78		{
79	5	$schemeFile = $this->getSchemaFile($jsonSchema, $ro);
80	4	$body = isset($ro->body[$jsonSchema->key]) ? $ro->body[$jsonSchema->key] : $ro->body;
81	4	$this->validate($body, $schemeFile);
82	2	}
83
84	5	private function validate($scanObject, $schemaFile)
85		{
86	5	$validator = new Validator;
87	5	$schema = (object) ['$ref' => 'file://' . $schemaFile];
88	5	$validator->validate($scanObject, $schema, Constraint::CHECK_MODE_TYPE_CAST);
89	5	$isValid = $validator->isValid();
90	5	if ($isValid) {
91	3	return;
92		}
93	3	$e = null;
94	3	foreach ($validator->getErrors() as $error) {
95	3	$msg = sprintf('[%s] %s', $error['property'], $error['message']);
96	3	$e = $e ? new JsonSchemaErrorException($msg, 0, $e) : new JsonSchemaErrorException($msg);
97		}
98	3	throw new JsonSchemaException($schemaFile, Code::ERROR, $e);
99		}
100
101	5	private function getSchemaFile(JsonSchema $jsonSchema, ResourceObject $ro) : string
102		{
103	5	if (! $jsonSchema->schema) {
104		// for BC only
105	1	$ref = new \ReflectionClass($ro);
106	1	$roFileName = $ro instanceof WeavedInterface ? $roFileName = $ref->getParentClass()->getFileName() : $ref->getFileName();
107	1	$bcFile = str_replace('.php', '.json', $roFileName);
108	1	if (file_exists($bcFile)) {
109	1	return $bcFile;
110		}
111		}
112	4	$schemaFile = $this->schemaDir . '/' . $jsonSchema->schema;
113	4	$this->validateFileExists($schemaFile);
114
115	3	return $schemaFile;
116		}
117
118	5	private function validateFileExists(string $schemaFile)
119		{
120	5	if (! file_exists($schemaFile) \|\| is_dir($schemaFile)) {
121	1	throw new JsonSchemaNotFoundException($schemaFile);
122		}
123	4	}
124
125	3	private function getNamedArguments(MethodInvocation $invocation)
126		{
127	3	$parameters = $invocation->getMethod()->getParameters();
128	3	$values = $invocation->getArguments();
129	3	$arguments = [];
130	3	foreach ($parameters as $index => $parameter) {
131	3	$arguments[$parameter->name] = $values[$index] ?? $parameter->getDefaultValue();
132		}
133
134	3	return $arguments;
135		}
136		}
137

bearsunday / BEAR.Resource

Branch — 1.x (2c7718)

JsonSchemaInterceptor::invoke() B

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like