JsonApiParser - Code Metrics - Inspection of "member names" - tuyakhov/yii2-json-api - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#14)

by Anton

created 2016-12-24 09:17 UTC

JsonApiParser A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	83
Duplicated Lines	14.46 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

Metric	Value
wmc	20
lcom	1
cbo	3
dl	12
loc	83
rs	10
c	0
b	0
f	0

3 Methods

Rating	Name	Duplication	Size	Complexity
C	parse()	12	36	16
A	typeToFormName()	0	7	2
A	parseMemberNames()	0	7	2

How to fix Duplicated Code

<?php
/**
 * @author Anton Tuyakhov <[email protected]>
 */

namespace tuyakhov\jsonapi;

use yii\base\InvalidConfigException;
use yii\helpers\ArrayHelper;
use yii\helpers\Inflector;
use \yii\web\JsonParser;

class JsonApiParser extends JsonParser
{
    /**
     * Converts 'type' member to form name
     * If not set, type will be converted to singular form.
     * For example, 'articles' will be converted to 'Article'
     * @var callable
     */
    public $formNameCallback;

    /**
     * Converts member names to variable names
     * If not set, all special characters will be replaced by underscore
     * For example, 'first-name' will be converted to 'first_name'
     * @var callable
     */
    public $memberNameCallback;

    /**
     * Parse resource object into the input data to populates the model
     * @inheritdoc
     */
    public function parse($rawBody, $contentType)
    {
        $array = parent::parse($rawBody, $contentType);
        if ($type = ArrayHelper::getValue($array, 'data.type')) {
            $formName = $this->typeToFormName($type);
            if ($attributes = ArrayHelper::getValue($array, 'data.attributes')) {
                $result[$formName] = array_combine($this->parseMemberNames(array_keys($attributes)), array_values($attributes));
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
            } elseif ($id = ArrayHelper::getValue($array, 'data.id')) {
                $result[$formName] = ['id' => $id, 'type' => $type];
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
            }
            if ($relationships = ArrayHelper::getValue($array, 'data.relationships')) {
                foreach ($relationships as $name => $relationship) {
                    if (isset($relationship[0])) {
                        foreach ($relationship as $item) {

                            if (isset($item['type']) && isset($item['id'])) {
                                $formName = $this->typeToFormName($item['type']);
$a = "a";
$ab = "ab";
$abc = "abc";
                                $result[$name][$formName][] = $item;
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
                            }
                        }
                    } elseif (isset($relationship['type']) && isset($relationship['id'])) {
                        $formName = $this->typeToFormName($relationship['type']);
$a = "a";
$ab = "ab";
$abc = "abc";
                        $result[$name][$formName] = $relationship;
                    }
                }
            }
        } else {
            $data = ArrayHelper::getValue($array, 'data', []);
            foreach ($data as $relationLink) {

                if (isset($relationLink['type']) && isset($relationLink['id'])) {
                    $formName = $this->typeToFormName($relationLink['type']);
$a = "a";
$ab = "ab";
$abc = "abc";
                    $result[$formName][] = $relationLink;
                }
            }
        }
        return isset($result) ? $result : $array;
    }

    /**
     * @param $type 'type' member of the document
     * @return string form name
     */
    protected function typeToFormName($type)
    {
        if ($this->formNameCallback !== null) {
            return call_user_func($this->formNameCallback, $type);
        }
        return Inflector::id2camel(Inflector::singularize($type));
    }

    /**
     * @param array $memberNames
     * @return array variable names
     */
    protected function parseMemberNames(array $memberNames = [])
    {
        $callback = $this->memberNameCallback !== null ? $this->memberNameCallback : function($name) {
            return str_replace(' ', '_', preg_replace('/[^A-Za-z0-9]+/', ' ', $name));
        };
        return array_map($callback, $memberNames);
    }
}



1		<?php
2		/**
3		* @author Anton Tuyakhov <[email protected]>
4		*/
5
6		namespace tuyakhov\jsonapi;
7
8		use yii\base\InvalidConfigException;
9		use yii\helpers\ArrayHelper;
10		use yii\helpers\Inflector;
11		use \yii\web\JsonParser;
12
13		class JsonApiParser extends JsonParser
14		{
15		/**
16		* Converts 'type' member to form name
17		* If not set, type will be converted to singular form.
18		* For example, 'articles' will be converted to 'Article'
19		* @var callable
20		*/
21		public $formNameCallback;
22
23		/**
24		* Converts member names to variable names
25		* If not set, all special characters will be replaced by underscore
26		* For example, 'first-name' will be converted to 'first_name'
27		* @var callable
28		*/
29		public $memberNameCallback;
30
31		/**
32		* Parse resource object into the input data to populates the model
33		* @inheritdoc
34		*/
35		public function parse($rawBody, $contentType)
36		{
37		$array = parent::parse($rawBody, $contentType);
38		if ($type = ArrayHelper::getValue($array, 'data.type')) {
39		$formName = $this->typeToFormName($type);
40		if ($attributes = ArrayHelper::getValue($array, 'data.attributes')) {
41		$result[$formName] = array_combine($this->parseMemberNames(array_keys($attributes)), array_values($attributes));
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-12-24 09:19 UTC by Report Bug Copy Issue Report `$result` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$result = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
42		} elseif ($id = ArrayHelper::getValue($array, 'data.id')) {
43		$result[$formName] = ['id' => $id, 'type' => $type];
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-11-12 13:03 UTC by Report Bug Copy Issue Report `$result` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$result = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
44		}
45		if ($relationships = ArrayHelper::getValue($array, 'data.relationships')) {
46		foreach ($relationships as $name => $relationship) {
47		if (isset($relationship[0])) {
48	View Code Duplication	foreach ($relationship as $item) {
		0 ignored issues – show Duplication introduced 2016-11-12 13:03 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...
49		if (isset($item['type']) && isset($item['id'])) {
50		$formName = $this->typeToFormName($item['type']);
		0 ignored issues – show Coding Style introduced 2016-12-24 09:19 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 19 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
51		$result[$name][$formName][] = $item;
		0 ignored issues – show Bug introduced 2016-11-12 13:03 UTC by Report Bug Copy Issue Report The variable `$result` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
52		}
53		}
54		} elseif (isset($relationship['type']) && isset($relationship['id'])) {
55		$formName = $this->typeToFormName($relationship['type']);
		0 ignored issues – show Coding Style introduced 2016-12-24 09:19 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 17 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
56		$result[$name][$formName] = $relationship;
57		}
58		}
59		}
60		} else {
61		$data = ArrayHelper::getValue($array, 'data', []);
62	View Code Duplication	foreach ($data as $relationLink) {
		0 ignored issues – show Duplication introduced 2016-11-12 13:03 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...
63		if (isset($relationLink['type']) && isset($relationLink['id'])) {
64		$formName = $this->typeToFormName($relationLink['type']);
		0 ignored issues – show Coding Style introduced 2016-12-24 09:19 UTC by Report Bug Copy Issue Report Equals sign not aligned with surrounding assignments; expected 12 spaces but found 1 space This check looks for multiple assignments in successive lines of code. It will report an issue if the operators are not in a straight line. To visualize $a = "a"; $ab = "ab"; $abc = "abc"; will produce issues in the first and second line, while this second example $a = "a"; $ab = "ab"; $abc = "abc"; will produce no issues. Loading history...
65		$result[$formName][] = $relationLink;
66		}
67		}
68		}
69		return isset($result) ? $result : $array;
70		}
71
72		/**
73		* @param $type 'type' member of the document
74		* @return string form name
75		*/
76		protected function typeToFormName($type)
77		{
78		if ($this->formNameCallback !== null) {
79		return call_user_func($this->formNameCallback, $type);
80		}
81		return Inflector::id2camel(Inflector::singularize($type));
82		}
83
84		/**
85		* @param array $memberNames
86		* @return array variable names
87		*/
88		protected function parseMemberNames(array $memberNames = [])
89		{
90		$callback = $this->memberNameCallback !== null ? $this->memberNameCallback : function($name) {
91		return str_replace(' ', '_', preg_replace('/[^A-Za-z0-9]+/', ' ', $name));
92		};
93		return array_map($callback, $memberNames);
94		}
95		}
		0 ignored issues – show Coding Style introduced 2016-04-11 12:58 UTC by Report Bug Copy Issue Report As per coding style, files should not end with a newline character. This check marks files that end in a newline character, i.e. an empy line. Loading history...
96

tuyakhov / yii2-json-api

Pull Request — master (#14)

JsonApiParser A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

3 Methods

How to fix Duplicated Code

Duplicated Code

Available Fixes

Duplication Side-by-Side

Filter issues like