InitController::actionComposer() - Code Metrics - Inspection of "minor" - hiqdev/hidev - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5f528b...a6b26f )

by Andrii

created 2016-10-17 08:06 UTC

InitController::actionComposer() A

↳ Parent: InitController

Complexity

Conditions	1
Paths	1

Size

Total Lines	14
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	1.0723

Importance

Changes

Metric	Value
dl	0
loc	14
ccs	7
cts	12
cp	0.5833
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	11
nc	1
nop	0
crap	1.0723

<?php

/*
 * Automation tool mixed with code generator for easier continuous development
 *
 * @link      https://github.com/hiqdev/hidev
 * @package   hidev
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2016, HiQDev (http://hiqdev.com/)
 */

namespace hidev\controllers;

use Exception;
use hidev\base\File;
use hidev\helpers\Helper;
use yii\base\InvalidParamException;

/**
 * Init controller.
 * Builds .hidev/config.yml by template and params.
 */
class InitController extends TemplateController
{
    protected $_file = '.hidev/config.yml';

    public $name;
    public $vendor;
    public $package;

    public function prepareData($name)
    {
        $this->name = $name;
        list($vendor, $package) = explode('/', $name, 2);
        if ($vendor) {
            $this->vendor = $vendor;
            $vendorPlugin = "$vendor/hidev-$vendor";
            try {
                $exists = @file_get_contents("https://packagist.org/packages/$vendorPlugin.json");
            } catch (Exception $e) {
                $exists = false;
            }
            if ($exists) {
                $this->setItem('vendorRequire', $vendorPlugin);
                $this->setItem('novendor', true);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            }
        }
        if ($package) {
            $this->package = $package;
        }
        if (!$this->package || !$this->vendor) {
            throw new InvalidParamException('Wrong vendor/package given: ' . $name);
        }
    }

    public function actionPerform($name = null, $template = '.hidev/config')
    {
        $this->_template = $template;
        $this->prepareData($name);
        if (!file_exists($this->dirname)) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            mkdir($this->dirname);
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
        }
        if (!$this->nocomposer) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            $this->actionComposer();
        }

        return parent::actionPerform();
    }

    public function actionComposer()
    {
        $file = new File(['path' => 'composer.json']);
        $data = array_filter([
            'name'        => $this->name,
            'type'        => $this->getType(),
            'description' => $this->getTitle(),
            'keywords'    => preg_split('/\s*,\s*/', $this->getKeywords()),
            'require-dev' => $this->getPlugins(),
            'license'     => $this->getItem('license'),
        ]);
        $file->save($data);
        $this->setItem('norequire', true);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    public function options($actionId)
    {
        return array_merge(parent::options($actionId), explode(',', 'namespace,headline,title,type,license,keywords,description,year,nick,author,email,novendor,norequire,nocomposer'));
    }

    public function getType()
    {
        return $this->getItem('type') ?: 'project';
    }

    public function getTitle()
    {
        return $this->getItem('title') ?: Helper::titleize($this->package);
    }

    public function getKeywords()
    {
        return $this->getItem('keywords') ?: implode(', ', explode('-', $this->package));
    }

    /// TODO think of better getting nick
    public function getNick()
    {
        return $this->getItem('nick') ?: preg_replace('/[^a-zA-Z_0-9]+/', '', `id -un`);
    }

    public function getAuthor()
    {
        return $this->getItem('author') ?: $this->takeVcs()->getUserName();
    }

    public function getEmail()
    {
        return $this->getItem('email') ?: $this->takeVcs()->getUserEmail();
    }

    /**
     * Returns list of plugins in composer requirements format: name => version.
     * @return array
     */
    public function getPlugins()
    {
        if ($this->norequire) {
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
            return [];
        }
        $res = [
            'hiqdev/hidev-php' => '<2.0 || dev-master',
        ];
        if ($this->vendorRequire) {

            $res[$this->vendorRequire] = '<2.0 || dev-master';

        }

        return $res;
    }
}


1		<?php
2
3		/*
4		* Automation tool mixed with code generator for easier continuous development
5		*
6		* @link https://github.com/hiqdev/hidev
7		* @package hidev
8		* @license BSD-3-Clause
9		* @copyright Copyright (c) 2015-2016, HiQDev (http://hiqdev.com/)
10		*/
11
12		namespace hidev\controllers;
13
14		use Exception;
15		use hidev\base\File;
16		use hidev\helpers\Helper;
17		use yii\base\InvalidParamException;
18
19		/**
20		* Init controller.
21		* Builds .hidev/config.yml by template and params.
22		*/
23		class InitController extends TemplateController
24		{
25		protected $_file = '.hidev/config.yml';
26
27		public $name;
28		public $vendor;
29		public $package;
30
31	3	public function prepareData($name)
32		{
33	3	$this->name = $name;
34		list($vendor, $package) = explode('/', $name, 2);
35	3	if ($vendor) {
36	3	$this->vendor = $vendor;
37	3	$vendorPlugin = "$vendor/hidev-$vendor";
38		try {
39		$exists = @file_get_contents("https://packagist.org/packages/$vendorPlugin.json");
40		} catch (Exception $e) {
41		$exists = false;
42	3	}
43	3	if ($exists) {
44		$this->setItem('vendorRequire', $vendorPlugin);
45		$this->setItem('novendor', true);
		0 ignored issues – show Documentation introduced 2016-03-16 10:10 UTC by Report Bug Copy Issue Report `true` is of type `boolean`, but the function expects a `array\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
46		}
47		}
48	3	if ($package) {
49	3	$this->package = $package;
50		}
51	3	if (!$this->package \|\| !$this->vendor) {
52		throw new InvalidParamException('Wrong vendor/package given: ' . $name);
53		}
54	3	}
55
56	3	public function actionPerform($name = null, $template = '.hidev/config')
57		{
58	3	$this->_template = $template;
59		$this->prepareData($name);
60		if (!file_exists($this->dirname)) {
		0 ignored issues – show Documentation introduced 2016-01-13 13:30 UTC by Report Bug Copy Issue Report The property `dirname` does not exist on `object<hidev\controllers\InitController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
61		mkdir($this->dirname);
		0 ignored issues – show Documentation introduced 2016-01-13 13:30 UTC by Report Bug Copy Issue Report The property `dirname` does not exist on `object<hidev\controllers\InitController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
62		}
63		if (!$this->nocomposer) {
		0 ignored issues – show Documentation introduced 2016-08-08 21:51 UTC by Report Bug Copy Issue Report The property `nocomposer` does not exist on `object<hidev\controllers\InitController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
64		$this->actionComposer();
65		}
66
67		return parent::actionPerform();
68		}
69
70	2	public function actionComposer()
71		{
72		$file = new File(['path' => 'composer.json']);
73		$data = array_filter([
74	2	'name' => $this->name,
75	2	'type' => $this->getType(),
76	2	'description' => $this->getTitle(),
77		'keywords' => preg_split('/\s,\s/', $this->getKeywords()),
78	2	'require-dev' => $this->getPlugins(),
79	2	'license' => $this->getItem('license'),
80		]);
81		$file->save($data);
82		$this->setItem('norequire', true);
		0 ignored issues – show Documentation introduced 2016-08-08 21:51 UTC by Report Bug Copy Issue Report `true` is of type `boolean`, but the function expects a `array\|null`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
83	2	}
84
85		public function options($actionId)
86		{
87		return array_merge(parent::options($actionId), explode(',', 'namespace,headline,title,type,license,keywords,description,year,nick,author,email,novendor,norequire,nocomposer'));
88		}
89
90		public function getType()
91		{
92		return $this->getItem('type') ?: 'project';
93		}
94
95		public function getTitle()
96		{
97		return $this->getItem('title') ?: Helper::titleize($this->package);
98		}
99
100		public function getKeywords()
101		{
102		return $this->getItem('keywords') ?: implode(', ', explode('-', $this->package));
103		}
104
105		/// TODO think of better getting nick
106		public function getNick()
107		{
108		return $this->getItem('nick') ?: preg_replace('/[^a-zA-Z_0-9]+/', '', `id -un`);
109		}
110
111		public function getAuthor()
112		{
113		return $this->getItem('author') ?: $this->takeVcs()->getUserName();
114		}
115
116		public function getEmail()
117		{
118		return $this->getItem('email') ?: $this->takeVcs()->getUserEmail();
119		}
120
121		/**
122		* Returns list of plugins in composer requirements format: name => version.
123		* @return array
124		*/
125	2	public function getPlugins()
126		{
127		if ($this->norequire) {
		0 ignored issues – show Documentation introduced 2016-08-08 21:51 UTC by Report Bug Copy Issue Report The property `norequire` does not exist on `object<hidev\controllers\InitController>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
128		return [];
129		}
130		$res = [
131		'hiqdev/hidev-php' => '<2.0 \|\| dev-master',
132	2	];
133		if ($this->vendorRequire) {
		0 ignored issues – show Bug introduced 2016-08-08 21:51 UTC by Report Bug Copy Issue Report The property `vendorRequire` does not seem to exist. Did you mean `vendor`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
134		$res[$this->vendorRequire] = '<2.0 \|\| dev-master';
		0 ignored issues – show Bug introduced 2016-08-08 21:51 UTC by Report Bug Copy Issue Report The property `vendorRequire` does not seem to exist. Did you mean `vendor`? An attempt at access to an undefined property has been detected. This may either be a typographical error or the property has been renamed but there are still references to its old name. If you really want to allow access to undefined properties, you can define magic methods to allow access. See the php core documentation on Overloading. Loading history...
135		}
136
137	2	return $res;
138		}
139		}
140

hiqdev / hidev

Push — master ( 5f528b...a6b26f )

InitController::actionComposer() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like