PHPDefinitionParser::parseMigrationDefinition() - Code Metrics - Inspection of "more flexibility in version management; export obj..." - kaliop-uk/ezmigrationbundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1ee05e...99144a )

by Gaetano

created 2018-12-02 15:10 UTC

PHPDefinitionParser::parseMigrationDefinition() B

↳ Parent: PHPDefinitionParser

Complexity

Conditions	6
Paths	18

Size

Total Lines

Duplication

Lines	11
Ratio	18.33 %

Code Coverage

Tests	0
CRAP Score	42

Importance

Changes

Metric	Value
dl	11
loc	60
c	0
b	0
f	0
ccs	0
cts	34
cp	0
rs	8.2505
cc	6
nc	18
nop	1
crap	42

How to fix Long Method

<?php

namespace Kaliop\eZMigrationBundle\Core\DefinitionParser;

use Kaliop\eZMigrationBundle\API\DefinitionParserInterface;
use Kaliop\eZMigrationBundle\API\Value\MigrationDefinition;
use Kaliop\eZMigrationBundle\API\Value\MigrationStep;
use PhpParser\Error;
use PhpParser\ParserFactory;

class PHPDefinitionParser implements DefinitionParserInterface
{
    protected $mandatoryInterface = 'Kaliop\eZMigrationBundle\API\MigrationInterface';

    /**
     * Tells whether the given file can be handled by this handler, by checking e.g. the suffix
     *
     * @param string $migrationName typically a filename
     * @return bool
     */
    public function supports($migrationName)
    {
        return pathinfo($migrationName, PATHINFO_EXTENSION) == 'php';
    }

    /**
     * Parses a migration definition file, and returns the list of actions to take
     *
     * @param MigrationDefinition $definition
     * @return MigrationDefinition
     */
    public function parseMigrationDefinition(MigrationDefinition $definition)
    {
        $status = MigrationDefinition::STATUS_PARSED;

        /// validate that php file is ok, contains a class with good interface
        $className = $this->getClassNameFromFile($definition->path);

        if ($className == '') {
            $status = MigrationDefinition::STATUS_INVALID;
            $message = 'The migration definition file should contain a valid class name. The class name is the part of the filename after the 1st underscore';
        } else {

            // we use smart parsing instead before plain file inclusion, by usage of nikic/php-parser
            // this should help with broken php migrations

            $pf = new ParserFactory();
            $parser = $pf->create(ParserFactory::PREFER_PHP7);
            try {
                $parser->parse(file_get_contents($definition->path));

                include_once($definition->path);

                if (!class_exists($className)) {
                    $status = MigrationDefinition::STATUS_INVALID;
                    $message = "The migration definition file should contain a valid class '$className'";
                } else {
                    $interfaces = class_implements($className);
                    if (!in_array($this->mandatoryInterface, $interfaces)) {
                        $status = MigrationDefinition::STATUS_INVALID;
                        $message = "The migration definition class '$className' should implement the interface '{$this->mandatoryInterface}'";
                    }
                }
            } catch (Error $e) {
                $status = MigrationDefinition::STATUS_INVALID;
                $message = "The migration definition file '{$definition->path}' is not valid php'";
            }
        }

        if ($status != MigrationDefinition::STATUS_PARSED)

        {
            return new MigrationDefinition(
                $definition->name,
                $definition->path,
                $definition->rawDefinition,
                $status,
                array(),
                $message
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

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

    // $x is potentially undefined here.
    echo $x;
}
            );
        }

        return new MigrationDefinition(
            $definition->name,
            $definition->path,
            $definition->rawDefinition,
            MigrationDefinition::STATUS_PARSED,
            array(
                new MigrationStep('php', array('class' => $className), array('path' => $definition->path))
            )
        );
    }

    /**
     * @param string $fileName
     * @return string|null
     */
    protected function getClassNameFromFile($fileName)
    {
        $parts = explode('_', pathinfo($fileName, PATHINFO_FILENAME), 2);
        return isset($parts[1]) ? $parts[1] : null;
    }
}


1		<?php
2
3		namespace Kaliop\eZMigrationBundle\Core\DefinitionParser;
4
5		use Kaliop\eZMigrationBundle\API\DefinitionParserInterface;
6		use Kaliop\eZMigrationBundle\API\Value\MigrationDefinition;
7		use Kaliop\eZMigrationBundle\API\Value\MigrationStep;
8		use PhpParser\Error;
9		use PhpParser\ParserFactory;
10
11		class PHPDefinitionParser implements DefinitionParserInterface
12		{
13		protected $mandatoryInterface = 'Kaliop\eZMigrationBundle\API\MigrationInterface';
14
15		/**
16		* Tells whether the given file can be handled by this handler, by checking e.g. the suffix
17		*
18		* @param string $migrationName typically a filename
19		* @return bool
20		*/
21		public function supports($migrationName)
22		{
23		return pathinfo($migrationName, PATHINFO_EXTENSION) == 'php';
24		}
25
26		/**
27		* Parses a migration definition file, and returns the list of actions to take
28		*
29		* @param MigrationDefinition $definition
30		* @return MigrationDefinition
31		*/
32		public function parseMigrationDefinition(MigrationDefinition $definition)
33		{
34		$status = MigrationDefinition::STATUS_PARSED;
35
36		/// validate that php file is ok, contains a class with good interface
37		$className = $this->getClassNameFromFile($definition->path);
38
39		if ($className == '') {
40		$status = MigrationDefinition::STATUS_INVALID;
41		$message = 'The migration definition file should contain a valid class name. The class name is the part of the filename after the 1st underscore';
42		} else {
43
44		// we use smart parsing instead before plain file inclusion, by usage of nikic/php-parser
45		// this should help with broken php migrations
46
47		$pf = new ParserFactory();
48		$parser = $pf->create(ParserFactory::PREFER_PHP7);
49		try {
50		$parser->parse(file_get_contents($definition->path));
51
52		include_once($definition->path);
53
54		if (!class_exists($className)) {
55		$status = MigrationDefinition::STATUS_INVALID;
56		$message = "The migration definition file should contain a valid class '$className'";
57		} else {
58		$interfaces = class_implements($className);
59		if (!in_array($this->mandatoryInterface, $interfaces)) {
60		$status = MigrationDefinition::STATUS_INVALID;
61		$message = "The migration definition class '$className' should implement the interface '{$this->mandatoryInterface}'";
62		}
63		}
64		} catch (Error $e) {
65		$status = MigrationDefinition::STATUS_INVALID;
66		$message = "The migration definition file '{$definition->path}' is not valid php'";
67		}
68		}
69
70	View Code Duplication	if ($status != MigrationDefinition::STATUS_PARSED)
		0 ignored issues – show Duplication introduced 2016-10-16 00:36 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...
71		{
72		return new MigrationDefinition(
73		$definition->name,
74		$definition->path,
75		$definition->rawDefinition,
76		$status,
77		array(),
78		$message
		0 ignored issues – show Bug introduced 2016-08-05 09:22 UTC by Report Bug Copy Issue Report The variable `$message` 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...
79		);
80		}
81
82		return new MigrationDefinition(
83		$definition->name,
84		$definition->path,
85		$definition->rawDefinition,
86		MigrationDefinition::STATUS_PARSED,
87		array(
88		new MigrationStep('php', array('class' => $className), array('path' => $definition->path))
89		)
90		);
91		}
92
93		/**
94		* @param string $fileName
95		* @return string\|null
96		*/
97		protected function getClassNameFromFile($fileName)
98		{
99		$parts = explode('_', pathinfo($fileName, PATHINFO_FILENAME), 2);
100		return isset($parts[1]) ? $parts[1] : null;
101		}
102		}
103

kaliop-uk / ezmigrationbundle

Push — master ( 1ee05e...99144a )

PHPDefinitionParser::parseMigrationDefinition() B

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Long Method

Long Method

Available Fixes

Duplication Side-by-Side

Filter issues like