Yaml::processContent() - Code Metrics - smalot/drush-cerbere - Measure and Improve Code Quality continuously with Scrutinizer

Yaml::processContent() A
last analyzed 2017-03-23 18:27 UTC

↳ Parent: Yaml

Complexity

Conditions	2
Paths	2

Size

Total Lines	14
Code Lines	8

Duplication

Lines	14
Ratio	100 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
cc	2
eloc	8
nc	2
nop	2
dl	14
loc	14
rs	9.4285
c	1
b	0
f	1

<?php

/**
 * Drush Cerbere command line tools.
 * Copyright (C) 2015 - Sebastien Malot <[email protected]>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

namespace Cerbere\Parser;

use Cerbere\Model\Project;
use Symfony\Component\Yaml\Exception\ParseException;

/**
 * Class Yaml
 * @package Cerbere\Parser
 */
class Yaml extends Ini
{
    /**
     * @var Project
     */
    protected $project;

    /**
     *
     */
    public function __construct()
    {

    }

    /**
     * @return string
     */
    public function getCode()
    {
        return 'yaml';
    }

    /**
     * @return Project[]
     */
    public function getProjects()
    {
        return array($this->getProject());
    }

    /**
     * @return Project
     */
    public function getProject()
    {
        return $this->project;
    }

    /**
     * @param string $content
     * @param string $filename
     */
    public function processContent($content, $filename = null)

    {
        $data = $this->parseContent($content);
        $data += array('project' => basename($filename, '.info.yml'), 'version' => '');

        $project = new Project($data['project'], $data['core'], $data['version']);
        $project->setDetails($data);

        if (!empty($filename)) {
            $project->setFilename(realpath($filename));
        }

        $this->project = $project;
    }

    /**
     * @param string $content
     * @return array
     * @throws ParseException
     */
    protected function parseContent($content)
    {
        $parsed_info = \Symfony\Component\Yaml\Yaml::parse($content);

        $missing_keys = array_diff($this->getRequiredKeys(), array_keys($parsed_info));

        if (!empty($missing_keys)) {
            throw new ParseException('Missing required keys (' . implode(', ', $missing_keys) . ')');
        }

        return $parsed_info;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * @return string[]
     */
    protected function getRequiredKeys()
    {
        return array('type', 'core', 'name');
    }

    /**
     * @param string $filename
     */
    public function processFile($filename)
    {
        $content = file_get_contents($filename);

        $this->processContent($content, $filename);
    }

    /**
     * @parser string $filename
     * @return boolean
     */
    public function supportedFile($filename)
    {
        return preg_match('/\.info\.yml$/i', $filename) > 0;
    }
}



1		<?php
2
3		/**
4		* Drush Cerbere command line tools.
5		* Copyright (C) 2015 - Sebastien Malot <[email protected]>
6		*
7		* This program is free software; you can redistribute it and/or modify
8		* it under the terms of the GNU General Public License as published by
9		* the Free Software Foundation; either version 2 of the License, or
10		* (at your option) any later version.
11		*
12		* This program is distributed in the hope that it will be useful,
13		* but WITHOUT ANY WARRANTY; without even the implied warranty of
14		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15		* GNU General Public License for more details.
16		*
17		* You should have received a copy of the GNU General Public License along
18		* with this program; if not, write to the Free Software Foundation, Inc.,
19		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20		*/
21
22		namespace Cerbere\Parser;
23
24		use Cerbere\Model\Project;
25		use Symfony\Component\Yaml\Exception\ParseException;
26
27		/**
28		* Class Yaml
29		* @package Cerbere\Parser
30		*/
31		class Yaml extends Ini
32		{
33		/**
34		* @var Project
35		*/
36		protected $project;
37
38		/**
39		*
40		*/
41		public function __construct()
42		{
43
44		}
45
46		/**
47		* @return string
48		*/
49		public function getCode()
50		{
51		return 'yaml';
52		}
53
54		/**
55		* @return Project[]
56		*/
57		public function getProjects()
58		{
59		return array($this->getProject());
60		}
61
62		/**
63		* @return Project
64		*/
65		public function getProject()
66		{
67		return $this->project;
68		}
69
70		/**
71		* @param string $content
72		* @param string $filename
73		*/
74	View Code Duplication	public function processContent($content, $filename = null)
		0 ignored issues – show Duplication introduced 2015-12-06 13:38 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
75		{
76		$data = $this->parseContent($content);
77		$data += array('project' => basename($filename, '.info.yml'), 'version' => '');
78
79		$project = new Project($data['project'], $data['core'], $data['version']);
80		$project->setDetails($data);
81
82		if (!empty($filename)) {
83		$project->setFilename(realpath($filename));
84		}
85
86		$this->project = $project;
87		}
88
89		/**
90		* @param string $content
91		* @return array
92		* @throws ParseException
93		*/
94		protected function parseContent($content)
95		{
96		$parsed_info = \Symfony\Component\Yaml\Yaml::parse($content);
97
98		$missing_keys = array_diff($this->getRequiredKeys(), array_keys($parsed_info));
99
100		if (!empty($missing_keys)) {
101		throw new ParseException('Missing required keys (' . implode(', ', $missing_keys) . ')');
102		}
103
104		return $parsed_info;
		0 ignored issues – show Bug Best Practice introduced 2017-03-23 18:27 UTC by Report Bug Copy Issue Report The return type of `return $parsed_info;` (`string\|array\|stdClass`) is incompatible with the return type of the parent method `Cerbere\Parser\Ini::parseContent` of type `array`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
105		}
106
107		/**
108		* @return string[]
109		*/
110		protected function getRequiredKeys()
111		{
112		return array('type', 'core', 'name');
113		}
114
115		/**
116		* @param string $filename
117		*/
118		public function processFile($filename)
119		{
120		$content = file_get_contents($filename);
121
122		$this->processContent($content, $filename);
123		}
124
125		/**
126		* @parser string $filename
127		* @return boolean
128		*/
129		public function supportedFile($filename)
130		{
131		return preg_match('/\.info\.yml$/i', $filename) > 0;
132		}
133		}
134
135

smalot / drush-cerbere

Yaml::processContent() A last analyzed 2017-03-23 18:27 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Yaml::processContent() A
last analyzed 2017-03-23 18:27 UTC