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

Completed

Push — master ( 978448...e188b3 )

by Andrii

created 2016-04-14 11:16 UTC

PhpunitController::prepareFile() A

↳ Parent: PhpunitController

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes	1
Bugs	0	Features	0

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

<?php

/*
 * PHPUnit plugin for HiDev
 *
 * @link      https://github.com/hiqdev/hidev-phpunit
 * @package   hidev-phpunit
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2016, HiQDev (http://hiqdev.com/)
 */

namespace hidev\phpunit\controllers;

use hidev\base\File;
use hidev\handlers\BaseHandler;
use Yii;

/**
 * Goal for Phpunit.
 */
class PhpunitController extends \hidev\controllers\CommonController
{
    protected $_before = ['phpunit/bootstrap', 'phpunit.xml.dist'];

    protected $_version;

    protected $_bootstrapFile;

    public $force;
    public $colors;
    public $coverageText;
    public $coverageClover;

    public function getConfiguration()
    {
        return $this->getGoal('phpunit.xml.dist');
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
    }

    public function getBootstrapFile()
    {
        if ($this->_bootstrapFile === null) {
            $this->_bootstrapFile = Yii::createObject([
                'class'     => File::class,
                'template'  => 'phpunit/bootstrap.twig',
                'path'      => 'tests/_bootstrap.php',
            ]);
        }

        return $this->_bootstrapFile;
    }

    public function actionBootstrap()
    {
        if (!$this->getBootstrapFile()->exists()) {
            $this->getBootstrapFile()->save();
        }
    }

    public function actionMake()
    {
        return $this->actionRun();
    }

    public function actionRun()
    {
        $args = [];
        if ($this->coverageText) {
            $args[] = '--coverage-text';
        }
        if ($this->coverageClover) {
            $args[] = '--coverage-clover=' . (is_string($this->coverageClover) ? $this->coverageClover : 'coverage.clover');
        }
        if ($this->colors) {
            $args[] = '--colors' . (version_compare($this->getVersion(), '4.7.0', '>=') ? '=' . $this->colors : '');
        }

        return $this->passthru('phpunit', $args);
    }

    public function getVersion()
    {
        if ($this->_version === null) {
            $lines = $this->exec('phpunit', ['--version']);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
            $a = explode(' ', $lines[0], 3)[1];
            $this->_version = $a;
        }

        return $this->_version;
    }

    public function actionGenfake($file)

    {
        $path = $this->buildFakePath($file);
        if (!$this->force && file_exists($path)) {
            Yii::warning("already exists: $path");
            return 1;
        }

        return $this->genFake($file, $path);
    }

    public function genFake($file, $path)
    {
        $text = $this->getView()->render('phpunit/fake.twig', [
            'class'         => $this->buildClass($file),
            'namespace'     => $this->buildTestNamespace(),
            'name'          => $file,
        ]);
        BaseHandler::write($path, $text);
    }

    public function actionGentest($file)

    {
        $path = $this->buildTestPath($file);
        if (!$this->force && file_exists($path)) {
            Yii::warning("already exists: $path");
            return 1;
        }

        return $this->genSkel($file);
    }

    public static function prepareFile($file)
    {
        return substr($file, -4) === '.php' ? substr($file, 0, -4) : $file;
    }

    public function genSkel($file)
    {
        $destPath = $this->buildTestPath($file);
        $dir = dirname($destPath);
        if (!file_exists($dir)) {
            mkdir($dir, 0777, true);
        }

        return $this->passthru('phpunit-skelgen', [
            'generate-test', '--bootstrap', 'tests/_bootstrap.php', '--',
            $this->buildClass($file), $this->buildPath($file), $this->buildTestClass($file), $destPath,
        ]);
    }

    public function buildNamespace($dir = '')
    {
        return $this->takePackage()->namespace . ($dir ? '\\' . strtr($dir, '/', '\\') : '');
    }

    public function buildTestNamespace($dir = 'tests\\unit')
    {
        return $this->buildNamespace($dir);
    }

    public function buildClass($file, $dir = '', $postfix = '')
    {
        return $this->buildNamespace($dir) . '\\' . strtr(static::prepareFile($file), '/', '\\') . $postfix;
    }

    public function buildTestClass($file, $dir = 'tests\\unit', $postfix = 'Test')
    {
        return $this->buildClass($file, $dir, $postfix);
    }

    public function buildPath($file, $dir = 'src', $prefix = '', $postfix = '')
    {
        return $dir . DIRECTORY_SEPARATOR . $prefix . static::prepareFile($file) . $postfix . '.php';

        ### XXX getting absolute path, think if needed
        #return strncmp($path, '/', 1) === 0 ? $path : Yii::getAlias("@prjdir/$path");

    }

    public function buildTestPath($file, $dir = 'tests/unit', $prefix = '', $postfix = 'Test')
    {
        return $this->buildPath($file, $dir, $prefix, $postfix);
    }

    public function buildFakePath($file, $dir = 'tests/unit', $prefix = 'Fake', $postfix = '')
    {
        return $this->buildPath($file, $dir, $prefix, $postfix);
    }
}


1		<?php
2
3		/*
4		* PHPUnit plugin for HiDev
5		*
6		* @link https://github.com/hiqdev/hidev-phpunit
7		* @package hidev-phpunit
8		* @license BSD-3-Clause
9		* @copyright Copyright (c) 2015-2016, HiQDev (http://hiqdev.com/)
10		*/
11
12		namespace hidev\phpunit\controllers;
13
14		use hidev\base\File;
15		use hidev\handlers\BaseHandler;
16		use Yii;
17
18		/**
19		* Goal for Phpunit.
20		*/
21		class PhpunitController extends \hidev\controllers\CommonController
22		{
23		protected $_before = ['phpunit/bootstrap', 'phpunit.xml.dist'];
24
25		protected $_version;
26
27		protected $_bootstrapFile;
28
29		public $force;
30		public $colors;
31		public $coverageText;
32		public $coverageClover;
33
34		public function getConfiguration()
35		{
36		return $this->getGoal('phpunit.xml.dist');
		0 ignored issues – show Documentation Bug introduced 2016-02-19 10:14 UTC by Report Bug Copy Issue Report The method `getGoal` does not exist on `object<hidev\phpunit\con...lers\PhpunitController>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
37		}
38
39		public function getBootstrapFile()
40		{
41		if ($this->_bootstrapFile === null) {
42		$this->_bootstrapFile = Yii::createObject([
43		'class' => File::class,
44		'template' => 'phpunit/bootstrap.twig',
45		'path' => 'tests/_bootstrap.php',
46		]);
47		}
48
49		return $this->_bootstrapFile;
50		}
51
52		public function actionBootstrap()
53		{
54		if (!$this->getBootstrapFile()->exists()) {
55		$this->getBootstrapFile()->save();
56		}
57		}
58
59		public function actionMake()
60		{
61		return $this->actionRun();
62		}
63
64		public function actionRun()
65		{
66		$args = [];
67		if ($this->coverageText) {
68		$args[] = '--coverage-text';
69		}
70		if ($this->coverageClover) {
71		$args[] = '--coverage-clover=' . (is_string($this->coverageClover) ? $this->coverageClover : 'coverage.clover');
72		}
73		if ($this->colors) {
74		$args[] = '--colors' . (version_compare($this->getVersion(), '4.7.0', '>=') ? '=' . $this->colors : '');
75		}
76
77		return $this->passthru('phpunit', $args);
78		}
79
80		public function getVersion()
81		{
82		if ($this->_version === null) {
83		$lines = $this->exec('phpunit', ['--version']);
		0 ignored issues – show Documentation introduced 2016-02-19 10:14 UTC by Report Bug Copy Issue Report `array('--version')` is of type `array<integer,string,{"0":"string"}>`, but the function expects a `string`. 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...
84		$a = explode(' ', $lines[0], 3)[1];
85		$this->_version = $a;
86		}
87
88		return $this->_version;
89		}
90
91	View Code Duplication	public function actionGenfake($file)
		0 ignored issues – show Duplication introduced 2016-01-14 11:20 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...
92		{
93		$path = $this->buildFakePath($file);
94		if (!$this->force && file_exists($path)) {
95		Yii::warning("already exists: $path");
96		return 1;
97		}
98
99		return $this->genFake($file, $path);
100		}
101
102		public function genFake($file, $path)
103		{
104		$text = $this->getView()->render('phpunit/fake.twig', [
105		'class' => $this->buildClass($file),
106		'namespace' => $this->buildTestNamespace(),
107		'name' => $file,
108		]);
109		BaseHandler::write($path, $text);
110		}
111
112	View Code Duplication	public function actionGentest($file)
		0 ignored issues – show Duplication introduced 2016-01-14 11:20 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...
113		{
114		$path = $this->buildTestPath($file);
115		if (!$this->force && file_exists($path)) {
116		Yii::warning("already exists: $path");
117		return 1;
118		}
119
120		return $this->genSkel($file);
121		}
122
123		public static function prepareFile($file)
124		{
125		return substr($file, -4) === '.php' ? substr($file, 0, -4) : $file;
126		}
127
128		public function genSkel($file)
129		{
130		$destPath = $this->buildTestPath($file);
131		$dir = dirname($destPath);
132		if (!file_exists($dir)) {
133		mkdir($dir, 0777, true);
134		}
135
136		return $this->passthru('phpunit-skelgen', [
137		'generate-test', '--bootstrap', 'tests/_bootstrap.php', '--',
138		$this->buildClass($file), $this->buildPath($file), $this->buildTestClass($file), $destPath,
139		]);
140		}
141
142		public function buildNamespace($dir = '')
143		{
144		return $this->takePackage()->namespace . ($dir ? '\\' . strtr($dir, '/', '\\') : '');
145		}
146
147		public function buildTestNamespace($dir = 'tests\\unit')
148		{
149		return $this->buildNamespace($dir);
150		}
151
152		public function buildClass($file, $dir = '', $postfix = '')
153		{
154		return $this->buildNamespace($dir) . '\\' . strtr(static::prepareFile($file), '/', '\\') . $postfix;
155		}
156
157		public function buildTestClass($file, $dir = 'tests\\unit', $postfix = 'Test')
158		{
159		return $this->buildClass($file, $dir, $postfix);
160		}
161
162		public function buildPath($file, $dir = 'src', $prefix = '', $postfix = '')
163		{
164		return $dir . DIRECTORY_SEPARATOR . $prefix . static::prepareFile($file) . $postfix . '.php';
165
166		### XXX getting absolute path, think if needed
167		#return strncmp($path, '/', 1) === 0 ? $path : Yii::getAlias("@prjdir/$path");
		0 ignored issues – show Unused Code Comprehensibility introduced 2016-04-14 11:19 UTC by Report Bug Copy Issue Report `57%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
168		}
169
170		public function buildTestPath($file, $dir = 'tests/unit', $prefix = '', $postfix = 'Test')
171		{
172		return $this->buildPath($file, $dir, $prefix, $postfix);
173		}
174
175		public function buildFakePath($file, $dir = 'tests/unit', $prefix = 'Fake', $postfix = '')
176		{
177		return $this->buildPath($file, $dir, $prefix, $postfix);
178		}
179		}
180

hiqdev / hidev-phpunit

Push — master ( 978448...e188b3 )

PhpunitController::prepareFile() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like