AbstractPage::setText() - Code Metrics - Inspection of "Implemented basic functionality of ApiStorage (#1)" - hiqdev/yii2-module-pages - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6b77c2...0b4fa8 )

by Andrii

created 2019-04-25 10:13 UTC

AbstractPage::setText() A

↳ Parent: AbstractPage

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	4
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	2

<?php
/**
 * Yii2 Pages Module
 *
 * @link      https://github.com/hiqdev/yii2-module-pages
 * @package   yii2-module-pages
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2016-2017, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\yii2\modules\pages\models;

use hiqdev\yii2\modules\pages\storage\FileSystemStorage;
use hiqdev\yii2\modules\pages\interfaces\StorageInterface;
use Symfony\Component\Yaml\Yaml;
use Yii;

abstract class AbstractPage extends \yii\base\BaseObject
{
    /** @var \yii\web\View */
    protected $view;

    public $layout;

    /** @var string */
    public $title;

    /** @var null|string */
    protected $path;

    /** @var string */
    protected $text;

    /** @var array  */
    protected $data = [];

    /** @var string */
    protected $url;

    /** @var StorageInterface  */
    protected $storage;

    public function __construct($path = null, StorageInterface $storage = null, $config = [])
    {
        if ($path) {
            $this->storage = $storage;
            list($data, $text) = $this->extractData($path);

            $this->path = $path;
            $this->text = $text;
            $this->setData($data);
        }

        $this->view = Yii::$app->view;
        parent::__construct($config);
    }

    public function setData($data)
    {
        if (!is_array($data)) {
            return;
        }
        $this->data = $data;
        foreach (['title', 'layout', 'url'] as $key) {
            if (isset($data[$key])) {
                $this->{$key} = $data[$key];
            }
        }
    }

    public function getData()
    {
        return $this->data;
    }

    public function getPath()
    {
        return $this->path;
    }

    public function getDate()
    {
        return $this->data['date'];
    }

    public function getUrl()
    {
        return $this->url ?: ['/pages/render/index', 'page' => $this->getPath()];
    }

    public static function createFromFile($path, FileSystemStorage $storage)
    {
        $extension = pathinfo($path)['extension'];
        $class = $storage->findPageClass($extension);

        return new $class($path, $storage);
    }

    public function extractData($path)

    {
        $lines = $this->storage->readArray($path);
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.
    }
}
        $yaml = $this->readQuotedLines($lines, '/^---$/', '/^---$/');
        if (empty($yaml)) {
            $data = [];
            $text = $lines;
        } else {
            $data = $this->readYaml($yaml);
            $text = array_slice($lines, count($yaml));
        }

        return [$data, implode("\n", $text)];
    }

    public function readFrontMatter($lines)
    {
        $yaml = $this->readQuotedLines($lines, '/^---$/', '/^---$/');
        if (empty($yaml)) {
            return [];
        }

        return empty($yaml) ? [] : $this->readYaml($yaml);
    }

    public function readYaml($lines)
    {
        $data = Yaml::parse(implode("\n", $lines));
        if (is_int($data['date'])) {
            $data['date'] = date('c', $data['date']);
        }

        return $data;
    }

    public function readQuotedLines($lines, $headMarker, $tailMarker)
    {
        $line = array_shift($lines);
        if (!preg_match($headMarker, $line, $matches)) {
            return null;
        }
        $res[] = ltrim(substr($line, strlen($matches[0])));
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

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

    // do something with $myArray
}
        while ($line) {
            $line = array_shift($lines);
            if (preg_match($tailMarker, $line, $matches)) {
                $res[] = rtrim(substr($line, 0, -strlen($matches[0])));
                break;
            }
            $res[] = $line;
        }

        return $res;
    }

    /**
     * Renders the page with given params.
     *
     * @param array $params
     * @abstract
     */
    abstract public function render(array $params = []);

    /**
     * @param string $text
     */
    public function setText(string $text): void
    {
        $this->text = $text;
    }

    /**
     * @param string $url
     */
    public function setUrl(string $url): void
    {
        $this->url = $url;
    }
}


1		<?php
2		/**
3		* Yii2 Pages Module
4		*
5		* @link https://github.com/hiqdev/yii2-module-pages
6		* @package yii2-module-pages
7		* @license BSD-3-Clause
8		* @copyright Copyright (c) 2016-2017, HiQDev (http://hiqdev.com/)
9		*/
10
11		namespace hiqdev\yii2\modules\pages\models;
12
13		use hiqdev\yii2\modules\pages\storage\FileSystemStorage;
14		use hiqdev\yii2\modules\pages\interfaces\StorageInterface;
15		use Symfony\Component\Yaml\Yaml;
16		use Yii;
17
18		abstract class AbstractPage extends \yii\base\BaseObject
19		{
20		/** @var \yii\web\View */
21		protected $view;
22
23		public $layout;
24
25		/** @var string */
26		public $title;
27
28		/** @var null\|string */
29		protected $path;
30
31		/** @var string */
32		protected $text;
33
34		/** @var array */
35		protected $data = [];
36
37		/** @var string */
38		protected $url;
39
40		/** @var StorageInterface */
41		protected $storage;
42
43		public function __construct($path = null, StorageInterface $storage = null, $config = [])
44		{
45		if ($path) {
46		$this->storage = $storage;
47		list($data, $text) = $this->extractData($path);
48
49		$this->path = $path;
50		$this->text = $text;
51		$this->setData($data);
52		}
53
54		$this->view = Yii::$app->view;
55		parent::__construct($config);
56		}
57
58		public function setData($data)
59		{
60		if (!is_array($data)) {
61		return;
62		}
63		$this->data = $data;
64		foreach (['title', 'layout', 'url'] as $key) {
65		if (isset($data[$key])) {
66		$this->{$key} = $data[$key];
67		}
68		}
69		}
70
71		public function getData()
72		{
73		return $this->data;
74		}
75
76		public function getPath()
77		{
78		return $this->path;
79		}
80
81		public function getDate()
82		{
83		return $this->data['date'];
84		}
85
86		public function getUrl()
87		{
88		return $this->url ?: ['/pages/render/index', 'page' => $this->getPath()];
89		}
90
91		public static function createFromFile($path, FileSystemStorage $storage)
92		{
93		$extension = pathinfo($path)['extension'];
94		$class = $storage->findPageClass($extension);
95
96		return new $class($path, $storage);
97		}
98
99	View Code Duplication	public function extractData($path)
		0 ignored issues – show Duplication introduced 2017-10-05 08:44 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...
100		{
101		$lines = $this->storage->readArray($path);
		0 ignored issues – show Bug introduced 2019-04-25 10:07 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `hiqdev\yii2\modules\page...rfaces\StorageInterface` as the method `readArray()` does only exist in the following implementations of said interface: `hiqdev\yii2\modules\page...orage\FileSystemStorage`. 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...
102		$yaml = $this->readQuotedLines($lines, '/^---$/', '/^---$/');
103		if (empty($yaml)) {
104		$data = [];
105		$text = $lines;
106		} else {
107		$data = $this->readYaml($yaml);
108		$text = array_slice($lines, count($yaml));
109		}
110
111		return [$data, implode("\n", $text)];
112		}
113
114		public function readFrontMatter($lines)
115		{
116		$yaml = $this->readQuotedLines($lines, '/^---$/', '/^---$/');
117		if (empty($yaml)) {
118		return [];
119		}
120
121		return empty($yaml) ? [] : $this->readYaml($yaml);
122		}
123
124		public function readYaml($lines)
125		{
126		$data = Yaml::parse(implode("\n", $lines));
127		if (is_int($data['date'])) {
128		$data['date'] = date('c', $data['date']);
129		}
130
131		return $data;
132		}
133
134		public function readQuotedLines($lines, $headMarker, $tailMarker)
135		{
136		$line = array_shift($lines);
137		if (!preg_match($headMarker, $line, $matches)) {
138		return null;
139		}
140		$res[] = ltrim(substr($line, strlen($matches[0])));
		0 ignored issues – show Coding Style Comprehensibility introduced 2017-03-14 10:12 UTC by Report Bug Copy Issue Report `$res` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$res = 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...
141		while ($line) {
142		$line = array_shift($lines);
143		if (preg_match($tailMarker, $line, $matches)) {
144		$res[] = rtrim(substr($line, 0, -strlen($matches[0])));
145		break;
146		}
147		$res[] = $line;
148		}
149
150		return $res;
151		}
152
153		/**
154		* Renders the page with given params.
155		*
156		* @param array $params
157		* @abstract
158		*/
159		abstract public function render(array $params = []);
160
161		/**
162		* @param string $text
163		*/
164		public function setText(string $text): void
165		{
166		$this->text = $text;
167		}
168
169		/**
170		* @param string $url
171		*/
172		public function setUrl(string $url): void
173		{
174		$this->url = $url;
175		}
176		}
177

hiqdev / yii2-module-pages

Push — master ( 6b77c2...0b4fa8 )

AbstractPage::setText() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like